Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/SubjectPerson | Version: 1.0.0 | |||
| Active as of 2024-12-18 | Responsible: HL7 | Computable Name: SubjectPerson | ||
The entity playing the role is a person (SubjectPerson class).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
 sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
 sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubjectPerson.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubjectPerson.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubjectPerson.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubjectPerson |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId |
0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| name |
0..* | PN | ||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
0..1 | TS | ||
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber |
0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| SubjectPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| SubjectPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| SubjectPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| SubjectPerson.administrativeGenderCode | example | AdministrativeGenderhttp://terminology.hl7.org/ValueSet/v3-AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | SubjectPerson.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
