FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/AlternateIdentification

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdAlternateIdentification
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-AlternateIdentification.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/AlternateIdentification
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameAlternateIdentification
TitleAlternateIdentification (CDA Class)
Realmau
Authoritynational
DescriptionThe alternateIdentification extension provides additional information about an identifier found in the linked role. The extensions augment the id information in the linked role. The id in the alternateIdentification extension SHALL match an id in the linked role. The alternateIdentification provides additional information about a particular identifier, such as its type. As an extension it needs to be safe for implementers to ignore this additional information.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AlternateIdentification
Kindlogical

Resources that use this resource

StructureDefinition
IdentifiedByIdentifiedBy (CDA Class)

Resources that this resource uses

StructureDefinition
CDCD: ConceptDescriptor (V3 Data Type)
CSCS: CodedSimpleValue (V3 Data Type)
IIII: InstanceIdentifier (V3 Data Type)
IVL-TSIVL_TS: Interval (V3 Data Type)
cs-simplecs: Coded Simple Value
ValueSet
CDARoleClassCDARoleClass
v3-ActStatusActStatus
v3-ActStatusActStatus

Narrative

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

The alternateIdentification extension provides additional information about an identifier found in the linked role. The extensions augment the id information in the linked role. The id in the alternateIdentification extension SHALL match an id in the linked role. The alternateIdentification provides additional information about a particular identifier, such as its type. As an extension it needs to be safe for implementers to ignore this additional information.


Source

{
  "resourceType": "StructureDefinition",
  "id": "AlternateIdentification",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "alternateIdentification"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/AlternateIdentification",
  "version": "1.0.0",
  "name": "AlternateIdentification",
  "title": "AlternateIdentification (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "The alternateIdentification extension provides additional information about an identifier found in the linked role. The extensions augment the id information in the linked role.  The id in the alternateIdentification extension SHALL match an id in the linked role. The alternateIdentification provides additional information about a particular identifier, such as its type. As an extension it needs to be safe for implementers to ignore this additional information.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/AlternateIdentification",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "AlternateIdentification",
        "path": "AlternateIdentification",
        "short": "Base for all types and resources",
        "definition": "Base definition for all types defined in FHIR type system.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "AlternateIdentification.classCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "AlternateIdentification.classCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "IDENT",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClass"
        }
      },
      {
        "id": "AlternateIdentification.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.id",
        "min": 1,
        "max": "1",
        "base": {
          "path": "AlternateIdentification.id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "AlternateIdentification.code",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AlternateIdentification.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ]
      },
      {
        "id": "AlternateIdentification.statusCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.statusCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AlternateIdentification.statusCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
        }
      },
      {
        "id": "AlternateIdentification.effectiveTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.effectiveTime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AlternateIdentification.effectiveTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "AlternateIdentification",
        "path": "AlternateIdentification",
        "min": 1,
        "max": "1"
      },
      {
        "id": "AlternateIdentification.classCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "IDENT",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClass"
        }
      },
      {
        "id": "AlternateIdentification.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.id",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "AlternateIdentification.code",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ]
      },
      {
        "id": "AlternateIdentification.statusCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.statusCode",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
        }
      },
      {
        "id": "AlternateIdentification.effectiveTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:v3"
          }
        ],
        "path": "AlternateIdentification.effectiveTime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      }
    ]
  }
}