FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-PARTY-RELATIONSHIP.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-PARTY-RELATIONSHIP.html
URLhttp://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NamePARTY_RELATIONSHIP
TitlePARTY_RELATIONSHIP
Realmuv
Authorityhl7
DescriptionGeneric description of a relationship between parties.
Typehttp://openehr.org/fhir/StructureDefinition/PARTY_RELATIONSHIP
Kindlogical

Resources that use this resource

StructureDefinition
openehr.base#0.1.0-snapshotPARTYPARTY

Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotDV-INTERVALDV_INTERVAL
openehr.base#0.1.0-snapshotITEM-STRUCTUREITEM_STRUCTURE
openehr.base#0.1.0-snapshotLOCATABLELOCATABLE
openehr.base#0.1.0-snapshotPARTY-REFPARTY_REF

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition PARTY-RELATIONSHIP

NameFlagsCard.TypeDescription & Constraintsdoco
.. PARTY_RELATIONSHIP C0..*LOCATABLEGeneric description of a relationship between parties.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Source_valid, Target_valid, Type_validity
... details 0..1ITEM_STRUCTUREThe detailed description of the relationship.
... target 1..1PARTY_REFTarget of relationship.
... time_validity 0..1DV_INTERVAL<DV_DATE>Valid time interval for this relationship.
... source 1..1PARTY_REFSource of relationship.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "PARTY-RELATIONSHIP",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "type",
      "name": "type",
      "title": "type",
      "status": "active",
      "kind": "operation",
      "description": "Type of relationship, such as  employment,  authority,  health provision ",
      "code": "type",
      "system": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "string"
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/development/demographic.html#_party_relationship_class"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#type"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-replace-cardinality"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    }
  ],
  "url": "http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP",
  "version": "0.1.0-snapshot",
  "name": "PARTY_RELATIONSHIP",
  "title": "PARTY_RELATIONSHIP",
  "status": "active",
  "experimental": false,
  "date": "2025-09-06T15:35:39+10:00",
  "publisher": "openEHR + HL7",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.openehr.org"
        }
      ]
    }
  ],
  "description": "Generic description of a relationship between parties.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://openehr.org/fhir/StructureDefinition/PARTY_RELATIONSHIP",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0-snapshot"
      }
    ],
    "element": [
      {
        "id": "PARTY_RELATIONSHIP",
        "path": "PARTY_RELATIONSHIP",
        "short": "Generic description of a relationship between parties.",
        "definition": "Generic description of a relationship between parties.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "Links_valid",
            "severity": "error",
            "human": "Links valid must be present",
            "expression": "links.exists() implies links.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetyped_valid",
            "severity": "error",
            "human": "Archetyped valid must satisfy exclusive conditions",
            "expression": "is_archetype_root() xor archetype_details .empty()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetype_node_id_valid",
            "severity": "error",
            "human": "Archetype node id valid must not be empty",
            "expression": "archetype_node_id.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Source_valid",
            "severity": "error",
            "human": "Source valid must be present",
            "expression": "source.exists() and then source.relationships.has (self)"
          },
          {
            "key": "Target_valid",
            "severity": "error",
            "human": "Target valid must be present",
            "expression": "target.exists() and then target.not().reverse_relationships.has (self)"
          },
          {
            "key": "Type_validity",
            "severity": "error",
            "human": "Type validity",
            "expression": "type() = name"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PARTY_RELATIONSHIP.name",
        "path": "PARTY_RELATIONSHIP.name",
        "short": "Runtime name of this fragment, used to build runtime paths.",
        "definition": "Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "LOCATABLE.name",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.archetype-node-id",
        "path": "PARTY_RELATIONSHIP.archetype_node_id",
        "short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
        "definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g.  `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "LOCATABLE.archetype_node_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.uid",
        "path": "PARTY_RELATIONSHIP.uid",
        "short": "Optional globally unique object identifier for root points of archetyped structures.",
        "definition": "Optional globally unique object identifier for root points of archetyped structures.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.uid",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.links",
        "path": "PARTY_RELATIONSHIP.links",
        "short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
        "definition": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "LOCATABLE.links",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LINK"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.archetype-details",
        "path": "PARTY_RELATIONSHIP.archetype_details",
        "short": "Details of archetyping used on this node.",
        "definition": "Details of archetyping used on this node.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.archetype_details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.feeder-audit",
        "path": "PARTY_RELATIONSHIP.feeder_audit",
        "short": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
        "definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.feeder_audit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.details",
        "path": "PARTY_RELATIONSHIP.details",
        "short": "The detailed description of the relationship.",
        "definition": "The detailed description of the relationship.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PARTY_RELATIONSHIP.details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.target",
        "path": "PARTY_RELATIONSHIP.target",
        "short": "Target of relationship.",
        "definition": "Target of relationship.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "PARTY_RELATIONSHIP.target",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.time-validity",
        "path": "PARTY_RELATIONSHIP.time_validity",
        "short": "Valid time interval for this relationship.",
        "definition": "Valid time interval for this relationship.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PARTY_RELATIONSHIP.time_validity",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.source",
        "path": "PARTY_RELATIONSHIP.source",
        "short": "Source of relationship.",
        "definition": "Source of relationship.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "PARTY_RELATIONSHIP.source",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PARTY_RELATIONSHIP",
        "path": "PARTY_RELATIONSHIP",
        "short": "Generic description of a relationship between parties.",
        "definition": "Generic description of a relationship between parties.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Source_valid",
            "severity": "error",
            "human": "Source valid must be present",
            "expression": "source.exists() and then source.relationships.has (self)"
          },
          {
            "key": "Target_valid",
            "severity": "error",
            "human": "Target valid must be present",
            "expression": "target.exists() and then target.not().reverse_relationships.has (self)"
          },
          {
            "key": "Type_validity",
            "severity": "error",
            "human": "Type validity",
            "expression": "type() = name"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.details",
        "path": "PARTY_RELATIONSHIP.details",
        "short": "The detailed description of the relationship.",
        "definition": "The detailed description of the relationship.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.target",
        "path": "PARTY_RELATIONSHIP.target",
        "short": "Target of relationship.",
        "definition": "Target of relationship.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.time-validity",
        "path": "PARTY_RELATIONSHIP.time_validity",
        "short": "Valid time interval for this relationship.",
        "definition": "Valid time interval for this relationship.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_RELATIONSHIP.source",
        "path": "PARTY_RELATIONSHIP.source",
        "short": "Source of relationship.",
        "definition": "Source of relationship.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      }
    ]
  }
}