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

FHIR IG analytics

Packagehl7.at.fhir.gkl.ig-tooling
Resource TypeStructureDefinition
IdStructureDefinition-CDAPatient.json
FHIR VersionR4
Sourcehttps://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling-test/0.5.3/StructureDefinition-CDAPatient.html
URLhttps://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling-test/StructureDefinition/CDAPatient
Version0.5.3
Statusdraft
Date2025-10-22T13:51:07+02:00
NameCDAPatient
TitleCDAPatient
Authorityhl7
DescriptionSome Patient
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
PatientPatient (CDA Class)

Narrative

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

Generated Narrative: StructureDefinition CDAPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientXML Namespace: urn:hl7-org:v3
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... birthTime 1..1TS

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "CDAPatient",
  "text": {
    "status": "extensions",
    "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-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "patient"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueUri": "cda"
    }
  ],
  "url": "https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling-test/StructureDefinition/CDAPatient",
  "version": "0.5.3",
  "name": "CDAPatient",
  "title": "CDAPatient",
  "status": "draft",
  "date": "2025-10-22T13:51:07+02:00",
  "description": "Some Patient",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/Patient",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Patient",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "2.0.0-sd-snapshot1"
      }
    ],
    "element": [
      {
        "id": "Patient",
        "path": "Patient",
        "short": "Base for all types and resources",
        "definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Patient.nullFlavor",
        "path": "Patient.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "Patient.realmCode",
        "path": "Patient.realmCode",
        "definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
        "min": 0,
        "max": "*",
        "base": {
          "path": "InfrastructureRoot.realmCode",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ]
      },
      {
        "id": "Patient.typeId",
        "path": "Patient.typeId",
        "definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "InfrastructureRoot.typeId",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Patient.typeId.nullFlavor",
        "path": "Patient.typeId.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "Patient.typeId.assigningAuthorityName",
        "path": "Patient.typeId.assigningAuthorityName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Assigning Authority Name",
        "definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.assigningAuthorityName",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "Patient.typeId.displayable",
        "path": "Patient.typeId.displayable",
        "representation": [
          "xmlAttr"
        ],
        "label": "Displayable",
        "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.displayable",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id": "Patient.typeId.root",
        "path": "Patient.typeId.root",
        "representation": [
          "xmlAttr"
        ],
        "label": "Root",
        "definition": "Identifies the type as an HL7 Registered model",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.root",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/oid",
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid",
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ],
        "fixedString": "2.16.840.1.113883.1.3"
      },
      {
        "id": "Patient.typeId.extension",
        "path": "Patient.typeId.extension",
        "representation": [
          "xmlAttr"
        ],
        "label": "Extension",
        "definition": "A character string as a unique identifier within the scope of the identifier root.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.extension",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "Patient.templateId",
        "path": "Patient.templateId",
        "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
        "min": 0,
        "max": "*",
        "base": {
          "path": "InfrastructureRoot.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Patient.classCode",
        "path": "Patient.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.classCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "PSN",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
        }
      },
      {
        "id": "Patient.determinerCode",
        "path": "Patient.determinerCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.determinerCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "INSTANCE",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
        }
      },
      {
        "id": "Patient.id",
        "path": "Patient.id",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Patient.name",
        "path": "Patient.name",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Patient.name",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PN"
          }
        ]
      },
      {
        "id": "Patient.sdtcDesc",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "desc"
          }
        ],
        "path": "Patient.sdtcDesc",
        "definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.sdtcDesc",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          }
        ]
      },
      {
        "id": "Patient.administrativeGenderCode",
        "path": "Patient.administrativeGenderCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.administrativeGenderCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-AdministrativeGender"
        }
      },
      {
        "id": "Patient.birthTime",
        "path": "Patient.birthTime",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Patient.birthTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "Patient.sdtcDeceasedInd",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "deceasedInd"
          }
        ],
        "path": "Patient.sdtcDeceasedInd",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.sdtcDeceasedInd",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
          }
        ]
      },
      {
        "id": "Patient.sdtcDeceasedTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "deceasedTime"
          }
        ],
        "path": "Patient.sdtcDeceasedTime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.sdtcDeceasedTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "Patient.sdtcMultipleBirthInd",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "multipleBirthInd"
          }
        ],
        "path": "Patient.sdtcMultipleBirthInd",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.sdtcMultipleBirthInd",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
          }
        ]
      },
      {
        "id": "Patient.sdtcMultipleBirthOrderNumber",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "multipleBirthOrderNumber"
          }
        ],
        "path": "Patient.sdtcMultipleBirthOrderNumber",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.sdtcMultipleBirthOrderNumber",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT-POS"
          }
        ]
      },
      {
        "id": "Patient.maritalStatusCode",
        "path": "Patient.maritalStatusCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.maritalStatusCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-MaritalStatus"
        }
      },
      {
        "id": "Patient.religiousAffiliationCode",
        "path": "Patient.religiousAffiliationCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.religiousAffiliationCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation"
        }
      },
      {
        "id": "Patient.raceCode",
        "path": "Patient.raceCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.raceCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Race"
        }
      },
      {
        "id": "Patient.sdtcRaceCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "raceCode"
          }
        ],
        "path": "Patient.sdtcRaceCode",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Patient.sdtcRaceCode",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Race"
        }
      },
      {
        "id": "Patient.ethnicGroupCode",
        "path": "Patient.ethnicGroupCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.ethnicGroupCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
        }
      },
      {
        "id": "Patient.sdtcEthnicGroupCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "ethnicGroupCode"
          }
        ],
        "path": "Patient.sdtcEthnicGroupCode",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Patient.sdtcEthnicGroupCode",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
        }
      },
      {
        "id": "Patient.guardian",
        "path": "Patient.guardian",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Patient.guardian",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Guardian"
          }
        ]
      },
      {
        "id": "Patient.birthplace",
        "path": "Patient.birthplace",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Patient.birthplace",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Birthplace"
          }
        ]
      },
      {
        "id": "Patient.languageCommunication",
        "path": "Patient.languageCommunication",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Patient.languageCommunication",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Patient",
        "path": "Patient"
      },
      {
        "id": "Patient.birthTime",
        "path": "Patient.birthTime",
        "min": 1
      }
    ]
  }
}