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

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-PARTY-IDENTITY.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-PARTY-IDENTITY.html
URLhttp://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NamePARTY_IDENTITY
TitlePARTY_IDENTITY
Realmuv
Authorityhl7
DescriptionAn identity owned by a Party, such as a person name or company name, and which is used by the Party to identify itself. Actual structure is archetyped.
Typehttp://openehr.org/fhir/StructureDefinition/PARTY_IDENTITY
Kindlogical

Resources that use this resource

StructureDefinition
openehr.base#0.1.0-snapshotPARTYPARTY

Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotITEM-STRUCTUREITEM_STRUCTURE
openehr.base#0.1.0-snapshotLOCATABLELOCATABLE

Narrative

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

Generated Narrative: StructureDefinition PARTY-IDENTITY

NameFlagsCard.TypeDescription & Constraintsdoco
.. PARTY_IDENTITY C0..*LOCATABLEAn identity owned by a Party, such as a person name or company name, and which is used by the Party to identify itself.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Purpose_valid
... details 1..1ITEM_STRUCTUREThe value of the identity.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "PARTY-IDENTITY",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "purpose",
      "name": "purpose",
      "title": "purpose",
      "status": "active",
      "kind": "operation",
      "description": "Purpose of identity, e.g. legal ,  stagename,  nickname,  tribal name,  trading name. Taken from value of inherited `_name_` attribute.",
      "code": "purpose",
      "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_identity_class"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#purpose"
    },
    {
      "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-IDENTITY",
  "version": "0.1.0-snapshot",
  "name": "PARTY_IDENTITY",
  "title": "PARTY_IDENTITY",
  "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": "An identity  owned  by a Party, such as a person name or company name, and which is used by the Party to identify itself. Actual structure is archetyped.",
  "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_IDENTITY",
  "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_IDENTITY",
        "path": "PARTY_IDENTITY",
        "short": "An identity  owned  by a Party, such as a person name or company name, and which is used by the Party to identify itself.",
        "definition": "An identity  owned  by a Party, such as a person name or company name, and which is used by the Party to identify itself. Actual structure is archetyped.",
        "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": "Purpose_valid",
            "severity": "error",
            "human": "Purpose valid",
            "expression": "purpose() = name"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PARTY_IDENTITY.name",
        "path": "PARTY_IDENTITY.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_IDENTITY.archetype-node-id",
        "path": "PARTY_IDENTITY.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_IDENTITY.uid",
        "path": "PARTY_IDENTITY.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_IDENTITY.links",
        "path": "PARTY_IDENTITY.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_IDENTITY.archetype-details",
        "path": "PARTY_IDENTITY.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_IDENTITY.feeder-audit",
        "path": "PARTY_IDENTITY.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_IDENTITY.details",
        "path": "PARTY_IDENTITY.details",
        "short": "The value of the identity.",
        "definition": "The value of the identity. This will often taken the form of a parseable string or a small structure of strings.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "PARTY_IDENTITY.details",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PARTY_IDENTITY",
        "path": "PARTY_IDENTITY",
        "short": "An identity  owned  by a Party, such as a person name or company name, and which is used by the Party to identify itself.",
        "definition": "An identity  owned  by a Party, such as a person name or company name, and which is used by the Party to identify itself. Actual structure is archetyped.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Purpose_valid",
            "severity": "error",
            "human": "Purpose valid",
            "expression": "purpose() = name"
          }
        ],
        "isModifier": false
      },
      {
        "id": "PARTY_IDENTITY.details",
        "path": "PARTY_IDENTITY.details",
        "short": "The value of the identity.",
        "definition": "The value of the identity. This will often taken the form of a parseable string or a small structure of strings.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      }
    ]
  }
}