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

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-PARTY.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-PARTY.html
URLhttp://openehr.org/fhir/StructureDefinition/PARTY
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NamePARTY
TitlePARTY
Realmuv
Authorityhl7
DescriptionAncestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The `_name_` attribute inherited from `LOCATABLE` is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the `_identities_` attribute, not the `_name_` attribute). NOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `PARTY` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. + For example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `PARTY` object.
Typehttp://openehr.org/fhir/StructureDefinition/PARTY
Kindlogical

Resources that use this resource

StructureDefinition
openehr.base#0.1.0-snapshotACTORACTOR
openehr.base#0.1.0-snapshotROLEROLE

Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotCONTACTCONTACT
openehr.base#0.1.0-snapshotITEM-STRUCTUREITEM_STRUCTURE
openehr.base#0.1.0-snapshotLOCATABLELOCATABLE
openehr.base#0.1.0-snapshotLOCATABLE-REFLOCATABLE_REF
openehr.base#0.1.0-snapshotPARTY-IDENTITYPARTY_IDENTITY
openehr.base#0.1.0-snapshotPARTY-RELATIONSHIPPARTY_RELATIONSHIP

Narrative

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

Generated Narrative: StructureDefinition PARTY

NameFlagsCard.TypeDescription & Constraintsdoco
.. PARTY C0..*LOCATABLEThis is an abstract type. Child types: ACTOR, ROLE
Ancestor of all Party types, including real world entities and their roles.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Type_valid, Identities_valid, Contacts_valid, Relationships_validity, Reverse_relationships_validity, Is_archetype_root, Uid_mandatory
... identities 1..*PARTY_IDENTITYIdentities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.
... contacts 0..*CONTACTContacts for this party.
... details 0..1ITEM_STRUCTUREAll other details for this Party.
... reverse_relationships 0..*LOCATABLE_REFReferences to relationships in which this Party takes part as target.
... relationships 0..*PARTY_RELATIONSHIPRelationships in which this Party takes part as source.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "PARTY",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "type",
      "name": "type",
      "title": "type",
      "status": "active",
      "kind": "operation",
      "description": "Type of party, such as  `PERSON`,  `ORGANISATION`, etc. Role name, e.g.  general practitioner ,  nurse ,  private citizen . Taken from inherited `_name_` attribute.",
      "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_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",
  "version": "0.1.0-snapshot",
  "name": "PARTY",
  "title": "PARTY",
  "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": "Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The `_name_` attribute inherited from `LOCATABLE` is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the `_identities_` attribute, not the `_name_` attribute).\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `PARTY` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2`  would be copied to the `_uid_` field of the `PARTY` object.",
  "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": true,
  "type": "http://openehr.org/fhir/StructureDefinition/PARTY",
  "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",
        "path": "PARTY",
        "short": "Ancestor of all Party types, including real world entities and their roles.",
        "definition": "Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The `_name_` attribute inherited from `LOCATABLE` is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the `_identities_` attribute, not the `_name_` attribute).\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `PARTY` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2`  would be copied to the `_uid_` field of the `PARTY` object.",
        "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": "Type_valid",
            "severity": "error",
            "human": "Type valid",
            "expression": "type() = name"
          },
          {
            "key": "Identities_valid",
            "severity": "error",
            "human": "Identities valid must not be empty",
            "expression": "identities.empty().not()"
          },
          {
            "key": "Contacts_valid",
            "severity": "error",
            "human": "Contacts valid must be present",
            "expression": "contacts.exists() implies contacts.empty().not()"
          },
          {
            "key": "Relationships_validity",
            "severity": "error",
            "human": "Relationships validity must be present",
            "expression": "relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)"
          },
          {
            "key": "Reverse_relationships_validity",
            "severity": "error",
            "human": "Reverse relationships validity must be present",
            "expression": "reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\\\"demographics\\\").all_party_relationships.has_object (item) and then repository(\\\"demographics\\\").all_party_relationships.object (item).target = self))"
          },
          {
            "key": "Is_archetype_root",
            "severity": "error",
            "human": "Is archetype root",
            "expression": "is_archetype_root()"
          },
          {
            "key": "Uid_mandatory",
            "severity": "error",
            "human": "Uid mandatory must be present",
            "expression": "uid.exists()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PARTY.name",
        "path": "PARTY.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.archetype-node-id",
        "path": "PARTY.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.uid",
        "path": "PARTY.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.links",
        "path": "PARTY.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.archetype-details",
        "path": "PARTY.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.feeder-audit",
        "path": "PARTY.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.identities",
        "path": "PARTY.identities",
        "short": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "definition": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "PARTY.identities",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.contacts",
        "path": "PARTY.contacts",
        "short": "Contacts for this party.",
        "definition": "Contacts for this party.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.contacts",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CONTACT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.details",
        "path": "PARTY.details",
        "short": "All other details for this Party.",
        "definition": "All other details for this Party.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PARTY.details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.reverse-relationships",
        "path": "PARTY.reverse_relationships",
        "short": "References to relationships in which this Party takes part as target.",
        "definition": "References to relationships in which this Party takes part as target.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.reverse_relationships",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.relationships",
        "path": "PARTY.relationships",
        "short": "Relationships in which this Party takes part as source.",
        "definition": "Relationships in which this Party takes part as source.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.relationships",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PARTY",
        "path": "PARTY",
        "short": "Ancestor of all Party types, including real world entities and their roles.",
        "definition": "Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The `_name_` attribute inherited from `LOCATABLE` is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the `_identities_` attribute, not the `_name_` attribute).\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `PARTY` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2`  would be copied to the `_uid_` field of the `PARTY` object.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Type_valid",
            "severity": "error",
            "human": "Type valid",
            "expression": "type() = name"
          },
          {
            "key": "Identities_valid",
            "severity": "error",
            "human": "Identities valid must not be empty",
            "expression": "identities.empty().not()"
          },
          {
            "key": "Contacts_valid",
            "severity": "error",
            "human": "Contacts valid must be present",
            "expression": "contacts.exists() implies contacts.empty().not()"
          },
          {
            "key": "Relationships_validity",
            "severity": "error",
            "human": "Relationships validity must be present",
            "expression": "relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)"
          },
          {
            "key": "Reverse_relationships_validity",
            "severity": "error",
            "human": "Reverse relationships validity must be present",
            "expression": "reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\\\"demographics\\\").all_party_relationships.has_object (item) and then repository(\\\"demographics\\\").all_party_relationships.object (item).target = self))"
          },
          {
            "key": "Is_archetype_root",
            "severity": "error",
            "human": "Is archetype root",
            "expression": "is_archetype_root()"
          },
          {
            "key": "Uid_mandatory",
            "severity": "error",
            "human": "Uid mandatory must be present",
            "expression": "uid.exists()"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.identities",
        "path": "PARTY.identities",
        "short": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "definition": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.contacts",
        "path": "PARTY.contacts",
        "short": "Contacts for this party.",
        "definition": "Contacts for this party.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CONTACT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.details",
        "path": "PARTY.details",
        "short": "All other details for this Party.",
        "definition": "All other details for this Party.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.reverse-relationships",
        "path": "PARTY.reverse_relationships",
        "short": "References to relationships in which this Party takes part as target.",
        "definition": "References to relationships in which this Party takes part as target.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY.relationships",
        "path": "PARTY.relationships",
        "short": "Relationships in which this Party takes part as source.",
        "definition": "Relationships in which this Party takes part as source.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP"
          }
        ],
        "isModifier": false
      }
    ]
  }
}