Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA, published by IHE Patient Care Coordination Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCSc/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/PCC/PSCc/StructureDefinition/IHE.PCC.MD.CDA | Version: 0.0.1-current | |||
| Draft as of 2025-11-04 | Computable Name: IHE_PCC_MedicalDocument_CDA | |||
This Structure Definition defines the base set of constraints used by almost all medical document profiles described the PCC Technical Framework.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
S | 1..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
 realmCode |
1..1 | CS | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
 @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| typeId |
SC | 1..1 | II | Constraints: II-1 |
| @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 | Fixed Value: POCD_HD000040 | |
 Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
  templateId:uv-realm |
S | 1..1 | II | |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
 @extension |
0..1 | st | ||
 templateId:us-realm |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem XML: category (urn:hl7-org:sdtc) |
| sdtcCategory:documentType |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). Binding: FHIRDocumentTypeCodes (example) | |
| @nullFlavor |
S | 0..1 | cs | Binding: CDANullFlavor (required) |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| sdtcStatusCode |
0..1 | CS | XML Namespace: urn:hl7-org:sdtc XML: statusCode (urn:hl7-org:sdtc) Binding: ActStatus (required) | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
1..1 | CE | ||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| languageCode |
S | 1..1 | CS | Binding: AllLanguages (required) |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| copyTime |
0..1 | TS | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RCT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| patientRole |
S | 1..1 | PatientRole | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassRelationshipFormal (required) Fixed Value: PAT | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
 useablePeriod |
0..* | |||
 useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| id |
0..1 | II | ||
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
C | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc Date of Death XML: deceasedTime (urn:hl7-org:sdtc) Constraints: should-value-att, ts-shall-year, ts-should-day |
| 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) | |
| maritalStatusCode |
0..1 | CE | Binding: MaritalStatus (example) | |
| religiousAffiliationCode |
0..1 | CE | Binding: ReligiousAffiliation (example) | |
| raceCode |
0..1 | CE | Binding: Race (example) | |
| sdtcRaceCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example) | |
| ethnicGroupCode |
0..1 | CE | Binding: Ethnicity (example) | |
| sdtcEthnicGroupCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example) | |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAgent (required) Fixed Value: GUARD | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| guardianPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| guardianOrganization |
0..1 | Organization | ||
| birthplace |
0..1 | Birthplace | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassPassive (required) Fixed Value: BIRTHPL | |
| place |
1..1 | Place | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassPlace (required) Fixed Value: PLC | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..1 | EN | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Binding: Country2 (required) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| modeCode |
0..1 | CE | Binding: LanguageAbilityMode (example) | |
| proficiencyLevelCode |
0..1 | CE | Binding: LanguageAbilityProficiency (example) | |
| preferenceInd |
0..1 | BL | ||
| providerOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
1..1 | TS | ||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. Binding: CDARoleCode (example) |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassDevice (required) Fixed Value: DEV | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| manufacturerModelName |
S | 1..1 | SC | Binding: Manufacturer Model Name Example (example) |
| softwareName |
S | 1..1 | SC | Binding: Software Name Example (example) |
| asMaintainedEntity |
0..* | MaintainedEntity | ||
| representedOrganization |
0..1 | Organization | ||
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: ENT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
 @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
0..* | TEL | ||
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CST | |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| sdtcTelecom |
0..* | TEL | XML Namespace: urn:hl7-org:sdtc The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. XML: telecom (urn:hl7-org:sdtc) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: XInformationRecipient (2.0.0) (required) | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAInformationRecipientRole (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| informationRecipient |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| receivedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 0..1 | IVL_TS | |
| associatedEntity |
1..1 | AssociatedEntity | ||
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipFulfills (2.0.0) (required) Fixed Value: FLFS | |
| order |
1..1 | Order | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMoodIntent (required) Fixed Value: RQO | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | Binding: v3 Code System ActCode (example) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| documentationOf |
0..* | DocumentationOf | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAActRelationshipType (required) Fixed Value: DOC | |
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | ||
| effectiveTime |
S | 1..1 | IVL_TS | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
S | 1..1 | IVXB_TS | |
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: x_ServiceEventPerformer (required) | |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| relatedDocument |
0..* | RelatedDocument | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipAuthorizedBy (required) Fixed Value: AUTH | |
| consent |
S | 1..1 | Consent | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: CONS | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. Binding: v3 Code System ActCode (example) | |
| statusCode |
S | 1..1 | CS | Binding: ActStatus (required) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) Fixed Value: COMP | |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
S | 1..1 | II | |
| code |
0..1 | CE | Binding: ActEncounterCode (example) | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| sdtcAdmissionReferralSourceCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: admissionReferralSourceCode (urn:hl7-org:sdtc) | |
| dischargeDispositionCode |
0..1 | CE | Binding: USEncounterDischargeDisposition (example) | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetLocation (required) Fixed Value: LOC | |
| healthCareFacility |
1..1 | HealthCareFacility | ||
| component |
1..1 | Component | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.classCode | Base | example | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.realmCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:uv-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:us-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcCategory:documentType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.code | Base | example | FHIR Document Type Codes | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcStatusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.recordTarget.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.classCode | Base | required | RoleClassRelationshipFormal | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.classCode | Base | required | RoleClassAgent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.classCode | Base | required | RoleClassPassive | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.classCode | Base | required | EntityClassPlace | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​use | Base | required | CDAPostalAddressUse | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.state.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.county.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.city.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumberNumeric.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.direction.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameBase.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.additionalLocator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationArea.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationQualifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryModeIdentifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.buildingNumberSuffix.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​modeCode | Base | example | LanguageAbilityMode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​proficiencyLevelCode | Base | example | LanguageAbilityProficiency | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​classCode | Base | required | EntityClassDevice | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​manufacturerModelName | Base | example | Manufacturer Model Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​softwareName | Base | example | Software Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeCode | Base | required | x_InformationRecipient | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​intendedRecipient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.classCode | Base | required | CDAInformationRecipientRole | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeCode | Base | required | ActRelationshipFulfills | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.inFulfillmentOf.​order.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.moodCode | Base | required | CDAActMoodIntent | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.inFulfillmentOf.​order.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeCode | Base | required | x_ServiceEventPerformer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeCode | Base | required | ActRelationshipAuthorizedBy | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​code | Base | example | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​dischargeDispositionCode | Base | example | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeCode | Base | required | ParticipationTargetLocation | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| AD-1 | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item | Can only have only one of the possible item elements in each choice |
(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
|
| II-1 | error | ClinicalDocument.typeId, ClinicalDocument.recordTarget.typeId, ClinicalDocument.recordTarget.patientRole.typeId, ClinicalDocument.recordTarget.patientRole.patient.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId, ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId, ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId, ClinicalDocument.author.typeId, ClinicalDocument.author.assignedAuthor.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId, ClinicalDocument.dataEnterer.typeId, ClinicalDocument.dataEnterer.assignedEntity.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:provider.typeId, ClinicalDocument.informant:provider.assignedEntity.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:non-provider.typeId, ClinicalDocument.custodian.typeId, ClinicalDocument.custodian.assignedCustodian.typeId, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId, ClinicalDocument.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId, ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId, ClinicalDocument.legalAuthenticator.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.authenticator.typeId, ClinicalDocument.authenticator.assignedEntity.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.participant.typeId, ClinicalDocument.inFulfillmentOf.typeId, ClinicalDocument.inFulfillmentOf.order.typeId, ClinicalDocument.documentationOf.typeId, ClinicalDocument.documentationOf.serviceEvent.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId, ClinicalDocument.authorization.typeId, ClinicalDocument.authorization.consent.typeId, ClinicalDocument.componentOf.typeId, ClinicalDocument.componentOf.encompassingEncounter.typeId, ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId, ClinicalDocument.componentOf.encompassingEncounter.location.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| signature | warning | ClinicalDocument.legalAuthenticator.signatureCode, ClinicalDocument.authenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
| text-null | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
This structure is derived from ClinicalDocument
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
| @classCode |
S | 1..1 | cs | |
| realmCode |
1..1 | CS | ||
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| typeId |
S | 1..1 | II | |
| @root |
1..1 | oid, uuid, ruid | ||
 @extension |
1..1 | st | ||
| Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
| templateId:uv-realm |
S | 1..1 | II | |
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
| templateId:us-realm |
0..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem |
| sdtcCategory:documentType |
S | 0..* | CD | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @displayName |
S | 1..1 | st | |
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). | |
| @nullFlavor |
S | 0..1 | cs | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @displayName |
S | 1..1 | st | |
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
||||
| @nullFlavor |
0..0 | |||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| languageCode |
S | 1..1 | CS | |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| patientRole |
S | 1..1 | PatientRole | |
| id |
S | 1..* | II | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedTime |
C | 0..1 | TS | Date of Death Constraints: should-value-att, ts-shall-year, ts-should-day |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| guardianPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| birthplace |
0..1 | Birthplace | ||
| place |
1..1 | Place | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| item |
||||
| country |
0..1 | ADXP | Binding: Country2 (required) | |
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| providerOrganization |
0..1 | Organization | ||
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| id |
S | 1..* | II | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. |
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| manufacturerModelName |
S | 1..1 | SC | |
| softwareName |
S | 1..1 | SC | |
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| id |
1..* | II | ||
| code |
0..1 | CE | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| relatedEntity |
0..0 | |||
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| assignedEntity |
0..0 | |||
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| sdtcTelecom |
0..* | TEL | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| id |
0..* | II | ||
| informationRecipient |
0..1 | Person | ||
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| receivedOrganization |
0..1 | Organization | ||
| name |
1..1 | ON | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| time |
S | 1..1 | TS | |
| signatureCode |
1..1 | CS | ||
| @code |
S | 1..1 | cs | Required Pattern: S |
| sdtcSignatureText |
0..1 | ED | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| time |
S | 1..1 | TS | |
| signatureCode |
1..1 | CS | ||
| @code |
S | 1..1 | cs | Required Pattern: S |
| sdtcSignatureText |
0..1 | ED | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | ||
| code |
||||
| @code |
0..1 | cs | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| time |
S | 0..1 | IVL_TS | |
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| order |
1..1 | Order | ||
| id |
S | 1..* | II | |
| documentationOf |
0..* | DocumentationOf | ||
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| effectiveTime |
S | 1..1 | IVL_TS | |
| low |
S | 1..1 | IVXB_TS | |
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| id |
1..* | II | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| consent |
S | 1..1 | Consent | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. | |
| statusCode |
S | 1..1 | CS | |
| @code |
1..1 | cs | ||
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| id |
S | 1..1 | II | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
S | 1..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
1..1 | CS | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| typeId |
SC | 1..1 | II | Constraints: II-1 |
| @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 | Fixed Value: POCD_HD000040 | |
| Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
| templateId:uv-realm |
S | 1..1 | II | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
| @extension |
0..1 | st | ||
| templateId:us-realm |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem XML: category (urn:hl7-org:sdtc) |
| sdtcCategory:documentType |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). Binding: FHIRDocumentTypeCodes (example) | |
| @nullFlavor |
S | 0..1 | cs | Binding: CDANullFlavor (required) |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| sdtcStatusCode |
0..1 | CS | XML Namespace: urn:hl7-org:sdtc XML: statusCode (urn:hl7-org:sdtc) Binding: ActStatus (required) | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
1..1 | CE | ||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| languageCode |
S | 1..1 | CS | Binding: AllLanguages (required) |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| copyTime |
0..1 | TS | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RCT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| patientRole |
S | 1..1 | PatientRole | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassRelationshipFormal (required) Fixed Value: PAT | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| id |
0..1 | II | ||
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
C | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc Date of Death XML: deceasedTime (urn:hl7-org:sdtc) Constraints: should-value-att, ts-shall-year, ts-should-day |
| 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) | |
| maritalStatusCode |
0..1 | CE | Binding: MaritalStatus (example) | |
| religiousAffiliationCode |
0..1 | CE | Binding: ReligiousAffiliation (example) | |
| raceCode |
0..1 | CE | Binding: Race (example) | |
| sdtcRaceCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example) | |
| ethnicGroupCode |
0..1 | CE | Binding: Ethnicity (example) | |
| sdtcEthnicGroupCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example) | |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAgent (required) Fixed Value: GUARD | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| guardianPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| guardianOrganization |
0..1 | Organization | ||
| birthplace |
0..1 | Birthplace | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassPassive (required) Fixed Value: BIRTHPL | |
| place |
1..1 | Place | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassPlace (required) Fixed Value: PLC | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..1 | EN | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Binding: Country2 (required) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| modeCode |
0..1 | CE | Binding: LanguageAbilityMode (example) | |
| proficiencyLevelCode |
0..1 | CE | Binding: LanguageAbilityProficiency (example) | |
| preferenceInd |
0..1 | BL | ||
| providerOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
1..1 | TS | ||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. Binding: CDARoleCode (example) |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassDevice (required) Fixed Value: DEV | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| manufacturerModelName |
S | 1..1 | SC | Binding: Manufacturer Model Name Example (example) |
| softwareName |
S | 1..1 | SC | Binding: Software Name Example (example) |
| asMaintainedEntity |
0..* | MaintainedEntity | ||
| representedOrganization |
0..1 | Organization | ||
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: ENT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
0..* | TEL | ||
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CST | |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| sdtcTelecom |
0..* | TEL | XML Namespace: urn:hl7-org:sdtc The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. XML: telecom (urn:hl7-org:sdtc) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: XInformationRecipient (2.0.0) (required) | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAInformationRecipientRole (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| informationRecipient |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| receivedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 0..1 | IVL_TS | |
| associatedEntity |
1..1 | AssociatedEntity | ||
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipFulfills (2.0.0) (required) Fixed Value: FLFS | |
| order |
1..1 | Order | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMoodIntent (required) Fixed Value: RQO | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | Binding: v3 Code System ActCode (example) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| documentationOf |
0..* | DocumentationOf | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAActRelationshipType (required) Fixed Value: DOC | |
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | ||
| effectiveTime |
S | 1..1 | IVL_TS | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
S | 1..1 | IVXB_TS | |
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: x_ServiceEventPerformer (required) | |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| relatedDocument |
0..* | RelatedDocument | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipAuthorizedBy (required) Fixed Value: AUTH | |
| consent |
S | 1..1 | Consent | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: CONS | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. Binding: v3 Code System ActCode (example) | |
| statusCode |
S | 1..1 | CS | Binding: ActStatus (required) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) Fixed Value: COMP | |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
S | 1..1 | II | |
| code |
0..1 | CE | Binding: ActEncounterCode (example) | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| sdtcAdmissionReferralSourceCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: admissionReferralSourceCode (urn:hl7-org:sdtc) | |
| dischargeDispositionCode |
0..1 | CE | Binding: USEncounterDischargeDisposition (example) | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetLocation (required) Fixed Value: LOC | |
| healthCareFacility |
1..1 | HealthCareFacility | ||
| component |
1..1 | Component | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.classCode | Base | example | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.realmCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:uv-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:us-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcCategory:documentType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.code | Base | example | FHIR Document Type Codes | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcStatusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.recordTarget.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.classCode | Base | required | RoleClassRelationshipFormal | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.classCode | Base | required | RoleClassAgent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.classCode | Base | required | RoleClassPassive | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.classCode | Base | required | EntityClassPlace | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​use | Base | required | CDAPostalAddressUse | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.state.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.county.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.city.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumberNumeric.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.direction.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameBase.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.additionalLocator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationArea.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationQualifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryModeIdentifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.buildingNumberSuffix.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​modeCode | Base | example | LanguageAbilityMode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​proficiencyLevelCode | Base | example | LanguageAbilityProficiency | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​classCode | Base | required | EntityClassDevice | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​manufacturerModelName | Base | example | Manufacturer Model Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​softwareName | Base | example | Software Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeCode | Base | required | x_InformationRecipient | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​intendedRecipient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.classCode | Base | required | CDAInformationRecipientRole | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeCode | Base | required | ActRelationshipFulfills | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.inFulfillmentOf.​order.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.moodCode | Base | required | CDAActMoodIntent | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.inFulfillmentOf.​order.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeCode | Base | required | x_ServiceEventPerformer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeCode | Base | required | ActRelationshipAuthorizedBy | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​code | Base | example | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​dischargeDispositionCode | Base | example | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeCode | Base | required | ParticipationTargetLocation | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| AD-1 | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item | Can only have only one of the possible item elements in each choice |
(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
|
| II-1 | error | ClinicalDocument.typeId, ClinicalDocument.recordTarget.typeId, ClinicalDocument.recordTarget.patientRole.typeId, ClinicalDocument.recordTarget.patientRole.patient.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId, ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId, ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId, ClinicalDocument.author.typeId, ClinicalDocument.author.assignedAuthor.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId, ClinicalDocument.dataEnterer.typeId, ClinicalDocument.dataEnterer.assignedEntity.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:provider.typeId, ClinicalDocument.informant:provider.assignedEntity.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:non-provider.typeId, ClinicalDocument.custodian.typeId, ClinicalDocument.custodian.assignedCustodian.typeId, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId, ClinicalDocument.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId, ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId, ClinicalDocument.legalAuthenticator.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.authenticator.typeId, ClinicalDocument.authenticator.assignedEntity.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.participant.typeId, ClinicalDocument.inFulfillmentOf.typeId, ClinicalDocument.inFulfillmentOf.order.typeId, ClinicalDocument.documentationOf.typeId, ClinicalDocument.documentationOf.serviceEvent.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId, ClinicalDocument.authorization.typeId, ClinicalDocument.authorization.consent.typeId, ClinicalDocument.componentOf.typeId, ClinicalDocument.componentOf.encompassingEncounter.typeId, ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId, ClinicalDocument.componentOf.encompassingEncounter.location.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| signature | warning | ClinicalDocument.legalAuthenticator.signatureCode, ClinicalDocument.authenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
| text-null | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
This structure is derived from ClinicalDocument
Summary
Mandatory: 24 elements(43 nested mandatory elements)
Must-Support: 97 elements
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
S | 1..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
1..1 | CS | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| typeId |
SC | 1..1 | II | Constraints: II-1 |
| @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 | Fixed Value: POCD_HD000040 | |
| Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
| templateId:uv-realm |
S | 1..1 | II | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
| @extension |
0..1 | st | ||
| templateId:us-realm |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem XML: category (urn:hl7-org:sdtc) |
| sdtcCategory:documentType |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). Binding: FHIRDocumentTypeCodes (example) | |
| @nullFlavor |
S | 0..1 | cs | Binding: CDANullFlavor (required) |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| sdtcStatusCode |
0..1 | CS | XML Namespace: urn:hl7-org:sdtc XML: statusCode (urn:hl7-org:sdtc) Binding: ActStatus (required) | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
1..1 | CE | ||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| languageCode |
S | 1..1 | CS | Binding: AllLanguages (required) |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| copyTime |
0..1 | TS | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RCT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| patientRole |
S | 1..1 | PatientRole | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassRelationshipFormal (required) Fixed Value: PAT | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| id |
0..1 | II | ||
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
C | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc Date of Death XML: deceasedTime (urn:hl7-org:sdtc) Constraints: should-value-att, ts-shall-year, ts-should-day |
| 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) | |
| maritalStatusCode |
0..1 | CE | Binding: MaritalStatus (example) | |
| religiousAffiliationCode |
0..1 | CE | Binding: ReligiousAffiliation (example) | |
| raceCode |
0..1 | CE | Binding: Race (example) | |
| sdtcRaceCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example) | |
| ethnicGroupCode |
0..1 | CE | Binding: Ethnicity (example) | |
| sdtcEthnicGroupCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example) | |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAgent (required) Fixed Value: GUARD | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| guardianPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| guardianOrganization |
0..1 | Organization | ||
| birthplace |
0..1 | Birthplace | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassPassive (required) Fixed Value: BIRTHPL | |
| place |
1..1 | Place | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassPlace (required) Fixed Value: PLC | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..1 | EN | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Binding: Country2 (required) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| modeCode |
0..1 | CE | Binding: LanguageAbilityMode (example) | |
| proficiencyLevelCode |
0..1 | CE | Binding: LanguageAbilityProficiency (example) | |
| preferenceInd |
0..1 | BL | ||
| providerOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
1..1 | TS | ||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. Binding: CDARoleCode (example) |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassDevice (required) Fixed Value: DEV | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| manufacturerModelName |
S | 1..1 | SC | Binding: Manufacturer Model Name Example (example) |
| softwareName |
S | 1..1 | SC | Binding: Software Name Example (example) |
| asMaintainedEntity |
0..* | MaintainedEntity | ||
| representedOrganization |
0..1 | Organization | ||
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: ENT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
0..* | TEL | ||
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CST | |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| sdtcTelecom |
0..* | TEL | XML Namespace: urn:hl7-org:sdtc The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. XML: telecom (urn:hl7-org:sdtc) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: XInformationRecipient (2.0.0) (required) | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAInformationRecipientRole (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| informationRecipient |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| receivedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 0..1 | IVL_TS | |
| associatedEntity |
1..1 | AssociatedEntity | ||
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipFulfills (2.0.0) (required) Fixed Value: FLFS | |
| order |
1..1 | Order | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMoodIntent (required) Fixed Value: RQO | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | Binding: v3 Code System ActCode (example) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| documentationOf |
0..* | DocumentationOf | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAActRelationshipType (required) Fixed Value: DOC | |
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | ||
| effectiveTime |
S | 1..1 | IVL_TS | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
S | 1..1 | IVXB_TS | |
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: x_ServiceEventPerformer (required) | |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| relatedDocument |
0..* | RelatedDocument | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipAuthorizedBy (required) Fixed Value: AUTH | |
| consent |
S | 1..1 | Consent | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: CONS | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. Binding: v3 Code System ActCode (example) | |
| statusCode |
S | 1..1 | CS | Binding: ActStatus (required) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) Fixed Value: COMP | |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
S | 1..1 | II | |
| code |
0..1 | CE | Binding: ActEncounterCode (example) | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| sdtcAdmissionReferralSourceCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: admissionReferralSourceCode (urn:hl7-org:sdtc) | |
| dischargeDispositionCode |
0..1 | CE | Binding: USEncounterDischargeDisposition (example) | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetLocation (required) Fixed Value: LOC | |
| healthCareFacility |
1..1 | HealthCareFacility | ||
| component |
1..1 | Component | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.classCode | Base | example | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.realmCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:uv-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:us-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcCategory:documentType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.code | Base | example | FHIR Document Type Codes | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcStatusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.recordTarget.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.classCode | Base | required | RoleClassRelationshipFormal | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.classCode | Base | required | RoleClassAgent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.classCode | Base | required | RoleClassPassive | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.classCode | Base | required | EntityClassPlace | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​use | Base | required | CDAPostalAddressUse | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.state.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.county.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.city.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumberNumeric.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.direction.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameBase.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.additionalLocator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationArea.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationQualifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryModeIdentifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.buildingNumberSuffix.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​modeCode | Base | example | LanguageAbilityMode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​proficiencyLevelCode | Base | example | LanguageAbilityProficiency | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​classCode | Base | required | EntityClassDevice | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​manufacturerModelName | Base | example | Manufacturer Model Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​softwareName | Base | example | Software Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeCode | Base | required | x_InformationRecipient | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​intendedRecipient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.classCode | Base | required | CDAInformationRecipientRole | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeCode | Base | required | ActRelationshipFulfills | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.inFulfillmentOf.​order.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.moodCode | Base | required | CDAActMoodIntent | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.inFulfillmentOf.​order.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeCode | Base | required | x_ServiceEventPerformer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeCode | Base | required | ActRelationshipAuthorizedBy | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​code | Base | example | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​dischargeDispositionCode | Base | example | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeCode | Base | required | ParticipationTargetLocation | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| AD-1 | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item | Can only have only one of the possible item elements in each choice |
(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
|
| II-1 | error | ClinicalDocument.typeId, ClinicalDocument.recordTarget.typeId, ClinicalDocument.recordTarget.patientRole.typeId, ClinicalDocument.recordTarget.patientRole.patient.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId, ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId, ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId, ClinicalDocument.author.typeId, ClinicalDocument.author.assignedAuthor.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId, ClinicalDocument.dataEnterer.typeId, ClinicalDocument.dataEnterer.assignedEntity.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:provider.typeId, ClinicalDocument.informant:provider.assignedEntity.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:non-provider.typeId, ClinicalDocument.custodian.typeId, ClinicalDocument.custodian.assignedCustodian.typeId, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId, ClinicalDocument.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId, ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId, ClinicalDocument.legalAuthenticator.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.authenticator.typeId, ClinicalDocument.authenticator.assignedEntity.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.participant.typeId, ClinicalDocument.inFulfillmentOf.typeId, ClinicalDocument.inFulfillmentOf.order.typeId, ClinicalDocument.documentationOf.typeId, ClinicalDocument.documentationOf.serviceEvent.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId, ClinicalDocument.authorization.typeId, ClinicalDocument.authorization.consent.typeId, ClinicalDocument.componentOf.typeId, ClinicalDocument.componentOf.encompassingEncounter.typeId, ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId, ClinicalDocument.componentOf.encompassingEncounter.location.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| signature | warning | ClinicalDocument.legalAuthenticator.signatureCode, ClinicalDocument.authenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
| text-null | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
Differential View
This structure is derived from ClinicalDocument
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
| @classCode |
S | 1..1 | cs | |
| realmCode |
1..1 | CS | ||
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| typeId |
S | 1..1 | II | |
| @root |
1..1 | oid, uuid, ruid | ||
| @extension |
1..1 | st | ||
| Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
| templateId:uv-realm |
S | 1..1 | II | |
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
| templateId:us-realm |
0..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem |
| sdtcCategory:documentType |
S | 0..* | CD | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @displayName |
S | 1..1 | st | |
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). | |
| @nullFlavor |
S | 0..1 | cs | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @displayName |
S | 1..1 | st | |
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
||||
| @nullFlavor |
0..0 | |||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| languageCode |
S | 1..1 | CS | |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| patientRole |
S | 1..1 | PatientRole | |
| id |
S | 1..* | II | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedTime |
C | 0..1 | TS | Date of Death Constraints: should-value-att, ts-shall-year, ts-should-day |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| guardianPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| birthplace |
0..1 | Birthplace | ||
| place |
1..1 | Place | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| item |
||||
| country |
0..1 | ADXP | Binding: Country2 (required) | |
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| providerOrganization |
0..1 | Organization | ||
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| id |
S | 1..* | II | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. |
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| manufacturerModelName |
S | 1..1 | SC | |
| softwareName |
S | 1..1 | SC | |
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| id |
1..* | II | ||
| code |
0..1 | CE | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| relatedEntity |
0..0 | |||
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| assignedEntity |
0..0 | |||
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| sdtcTelecom |
0..* | TEL | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| id |
0..* | II | ||
| informationRecipient |
0..1 | Person | ||
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| receivedOrganization |
0..1 | Organization | ||
| name |
1..1 | ON | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| time |
S | 1..1 | TS | |
| signatureCode |
1..1 | CS | ||
| @code |
S | 1..1 | cs | Required Pattern: S |
| sdtcSignatureText |
0..1 | ED | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| time |
S | 1..1 | TS | |
| signatureCode |
1..1 | CS | ||
| @code |
S | 1..1 | cs | Required Pattern: S |
| sdtcSignatureText |
0..1 | ED | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| id |
1..* | II | ||
| code |
||||
| @code |
0..1 | cs | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @use |
S | 0..* | cs | |
| assignedPerson |
S | 1..1 | Person | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| time |
S | 0..1 | IVL_TS | |
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| order |
1..1 | Order | ||
| id |
S | 1..* | II | |
| documentationOf |
0..* | DocumentationOf | ||
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| effectiveTime |
S | 1..1 | IVL_TS | |
| low |
S | 1..1 | IVXB_TS | |
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| id |
1..* | II | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| consent |
S | 1..1 | Consent | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. | |
| statusCode |
S | 1..1 | CS | |
| @code |
1..1 | cs | ||
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| id |
S | 1..1 | II | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalDocument |
C | 1..1 | ClinicalDocument | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: 4537-6380, 4537-6387, should-legalAuthenticator, should-relatedParticipant |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
S | 1..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
1..1 | CS | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
SC | 1..1 | cs | Constraints: ihe-pcc-realmCode-1 |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| typeId |
SC | 1..1 | II | Constraints: II-1 |
| @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 | Fixed Value: POCD_HD000040 | |
| Slices for templateId |
SC | 1..* | II | Slice: Unordered, Open by value:root, value:extension Constraints: ihe-pcc-realmCode-2 |
| templateId:uv-realm |
S | 1..1 | II | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.1.1 | |
| @extension |
0..1 | st | ||
| templateId:us-realm |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| id |
S | 1..1 | II | **SHALL** be a globally unique identifier for the document (CONF:4537-9991). |
| Slices for sdtcCategory |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc Used to categorize the document type.. Slice: Unordered, Open by value:code, value:codeSystem XML: category (urn:hl7-org:sdtc) |
| sdtcCategory:documentType |
S | 0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| code |
1..1 | CE | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). Binding: FHIRDocumentTypeCodes (example) | |
| @nullFlavor |
S | 0..1 | cs | Binding: CDANullFlavor (required) |
| @code |
S | 1..1 | cs | |
| @codeSystem |
S | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 |
| @codeSystemName |
S | 1..1 | st | Required Pattern: LOINC |
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
S | 1..1 | st | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code | |
| sdtcStatusCode |
0..1 | CS | XML Namespace: urn:hl7-org:sdtc XML: statusCode (urn:hl7-org:sdtc) Binding: ActStatus (required) | |
| effectiveTime |
S | 1..1 | TS | |
| confidentialityCode |
1..1 | CE | ||
| @code |
S | 0..1 | cs | Binding: Confidentiality (preferred) |
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| languageCode |
S | 1..1 | CS | Binding: AllLanguages (required) |
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| copyTime |
0..1 | TS | ||
| recordTarget |
S | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RCT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| patientRole |
S | 1..1 | PatientRole | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassRelationshipFormal (required) Fixed Value: PAT | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| patient |
SC | 1..1 | Patient | Constraints: 4537-32993, 4537-21000, should-us-addr, should-maritalStatusCode, should-us-languageCommunication |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| id |
0..1 | II | ||
| name |
SC | 1..* | PN | Constraints: iti-pdqm-patname |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode |
0..1 | CE | Binding: AdministrativeGender (example) | |
| birthTime |
SC | 1..1 | TS | Constraints: ts-shall-year, ts-should-day |
| sdtcDeceasedInd |
0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime |
C | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc Date of Death XML: deceasedTime (urn:hl7-org:sdtc) Constraints: should-value-att, ts-shall-year, ts-should-day |
| 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) | |
| maritalStatusCode |
0..1 | CE | Binding: MaritalStatus (example) | |
| religiousAffiliationCode |
0..1 | CE | Binding: ReligiousAffiliation (example) | |
| raceCode |
0..1 | CE | Binding: Race (example) | |
| sdtcRaceCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example) | |
| ethnicGroupCode |
0..1 | CE | Binding: Ethnicity (example) | |
| sdtcEthnicGroupCode |
0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example) | |
| guardian |
SC | 0..* | Guardian | Constraints: should-us-code, should-us-addr, should-us-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAgent (required) Fixed Value: GUARD | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Binding: PersonalAndLegalRelationshipRoleType (preferred) |
| addr |
SC | 0..* | AD | Constraints: should-country |
| telecom |
SC | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| guardianPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| guardianOrganization |
0..1 | Organization | ||
| birthplace |
0..1 | Birthplace | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassPassive (required) Fixed Value: BIRTHPL | |
| place |
1..1 | Place | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassPlace (required) Fixed Value: PLC | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..1 | EN | ||
| addr |
SC | 1..1 | AD | Constraints: should-country |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @isNotOrdered |
0..1 | bl | ||
| @use |
0..* | cs | Binding: CDAPostalAddressUse (required) | |
| item |
C | 0..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance Constraints: AD-1 |
| (Choice of one) |
1..1 | |||
| delimiter |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DEL | |
| country |
C | 0..1 | ADXP | Binding: Country2 (required) Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CNT | |
| state |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STA | |
| county |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CPA | |
| city |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CTY | |
| postalCode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ZIP | |
| streetAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: SAL | |
| houseNumber |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNR | |
| houseNumberNumeric |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNN | |
| direction |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DIR | |
| streetName |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STR | |
| streetNameBase |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STB | |
| streetNameType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: STTYP | |
| additionalLocator |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: ADL | |
| unitID |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNID | |
| unitType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: UNIT | |
| careOf |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CAR | |
| censusTract |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: CEN | |
| deliveryAddressLine |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DAL | |
| deliveryInstallationType |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINST | |
| deliveryInstallationArea |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTA | |
| deliveryInstallationQualifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DINSTQ | |
| deliveryMode |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMOD | |
| deliveryModeIdentifier |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: DMODID | |
| buildingNumberSuffix |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: BNS | |
| postBox |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: POB | |
| precinct |
C | 0..1 | ADXP | Constraints: text-null |
| (Choice of one) |
1..1 | |||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| @representation |
0..1 | cs | Fixed Value: TXT | |
| @mediaType |
0..1 | cs | Fixed Value: text/plain | |
| @language |
0..1 | cs | ||
| @partType |
0..1 | cs | Fixed Value: PRE | |
| xmlText |
0..1 | st | Allows for mixed text content | |
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| languageCommunication |
SC | 0..* | LanguageCommunication | Constraints: should-proficiencyLevelCode, should-preferenceInd |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| languageCode |
S | 1..1 | CS | Binding: Languages (required) |
| modeCode |
0..1 | CE | Binding: LanguageAbilityMode (example) | |
| proficiencyLevelCode |
0..1 | CE | Binding: LanguageAbilityProficiency (example) | |
| preferenceInd |
0..1 | BL | ||
| providerOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
S | 1..* | II | |
| name |
S | 1..* | ON | |
| telecom |
C | 1..* | TEL | Constraints: should-use |
| addr |
SC | 1..* | AD | Constraints: should-country |
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| author |
1..* | Author | The author element represents the creator of the clinical document. The author may be a device or a person. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
1..1 | TS | ||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: 4537-16790, should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
S | 0..1 | CE | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code. Binding: CDARoleCode (example) |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| (Choice of one) |
1..1 | |||
| assignedPerson |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassDevice (required) Fixed Value: DEV | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| manufacturerModelName |
S | 1..1 | SC | Binding: Manufacturer Model Name Example (example) |
| softwareName |
S | 1..1 | SC | Binding: Software Name Example (example) |
| asMaintainedEntity |
0..* | MaintainedEntity | ||
| representedOrganization |
0..1 | Organization | ||
| dataEnterer |
0..1 | DataEnterer | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: ENT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 0..1 | TS | |
| assignedEntity |
S | 1..1 | AssignedEntity | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| Slices for informant |
0..* | Informant | Slice: Unordered, Open by exists:relatedEntity, exists:assignedEntity | |
| informant:provider |
0..* | Informant | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: NUCCProviderCodes (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
0..* | TEL | ||
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| informant:non-provider |
0..* | Informant | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: INF | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| relatedEntity |
S | 1..1 | RelatedEntity | |
| custodian |
S | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: CST | |
| assignedCustodian |
1..1 | AssignedCustodian | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| representedCustodianOrganization |
1..1 | CustodianOrganization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
1..* | II | ||
| name |
S | 1..1 | ON | |
| telecom |
SC | 1..1 | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| sdtcTelecom |
0..* | TEL | XML Namespace: urn:hl7-org:sdtc The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. XML: telecom (urn:hl7-org:sdtc) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| informationRecipient |
0..* | InformationRecipient | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: XInformationRecipient (2.0.0) (required) | |
| intendedRecipient |
1..1 | IntendedRecipient | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAInformationRecipientRole (required) | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| informationRecipient |
0..1 | Person | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| receivedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| legalAuthenticator |
S | 0..1 | LegalAuthenticator | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LA | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| authenticator |
0..* | Authenticator | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUTHEN | |
| time |
S | 1..1 | TS | |
| signatureCode |
C | 1..1 | CS | Binding: CDASignatureCode (required) Constraints: signature |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
S | 1..1 | cs | Required Pattern: S |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| sdtcSignatureText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013. XML: signatureText (urn:hl7-org:sdtc) | |
| assignedEntity |
1..1 | AssignedEntity | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| addr |
SC | 1..* | AD | Constraints: should-country |
| telecom |
SC | 1..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
S | 1..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | |
| name |
SC | 1..* | PN | Constraints: ihe-pcc-person-name |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | cs | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| participant |
C | 0..* | Participant1 | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin). Constraints: 4537-10006 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 0..1 | IVL_TS | |
| associatedEntity |
1..1 | AssociatedEntity | ||
| inFulfillmentOf |
0..* | InFulfillmentOf | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipFulfills (2.0.0) (required) Fixed Value: FLFS | |
| order |
1..1 | Order | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMoodIntent (required) Fixed Value: RQO | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | Binding: v3 Code System ActCode (example) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| documentationOf |
0..* | DocumentationOf | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAActRelationshipType (required) Fixed Value: DOC | |
| serviceEvent |
C | 1..1 | ServiceEvent | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template. Constraints: should-us-performer |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | ||
| effectiveTime |
S | 1..1 | IVL_TS | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
S | 1..1 | IVXB_TS | |
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| performer |
S | 0..* | Performer1 | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
1..1 | cs | Binding: x_ServiceEventPerformer (required) | |
| functionCode |
SC | 0..1 | CE | Constraints: should-code-attr |
| time |
S | 0..1 | IVL_TS | |
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-us-code |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| relatedDocument |
0..* | RelatedDocument | ||
| authorization |
0..* | Authorization | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipAuthorizedBy (required) Fixed Value: AUTH | |
| consent |
S | 1..1 | Consent | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: CONS | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..* | II | ||
| code |
0..1 | CE | The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code. Binding: v3 Code System ActCode (example) | |
| statusCode |
S | 1..1 | CS | Binding: ActStatus (required) |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| componentOf |
S | 0..1 | ComponentOf | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) Fixed Value: COMP | |
| encompassingEncounter |
C | 1..1 | EncompassingEncounter | Constraints: should-responsibleParty |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
S | 1..1 | II | |
| code |
0..1 | CE | Binding: ActEncounterCode (example) | |
| effectiveTime |
S | 1..1 | IVL_TS | |
| sdtcAdmissionReferralSourceCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: admissionReferralSourceCode (urn:hl7-org:sdtc) | |
| dischargeDispositionCode |
0..1 | CE | Binding: USEncounterDischargeDisposition (example) | |
| responsibleParty |
SC | 0..1 | InfrastructureRoot | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| assignedEntity |
SC | 1..1 | AssignedEntity | Constraints: 1198-32905 |
| encounterParticipant |
C | 0..* | EncounterParticipant | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care. Constraints: 1198-8348 |
| location |
S | 0..1 | InfrastructureRoot | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetLocation (required) Fixed Value: LOC | |
| healthCareFacility |
1..1 | HealthCareFacility | ||
| component |
1..1 | Component | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalDocument.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.classCode | Base | example | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.realmCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:uv-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.templateId:us-realm.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcCategory:documentType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.code | Base | example | FHIR Document Type Codes | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.sdtcStatusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.confidentialityCode.​code | Base | preferred | Confidentiality | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| ClinicalDocument.recordTarget.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.classCode | Base | required | RoleClassRelationshipFormal | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.classCode | Base | required | RoleClassAgent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.code | Base | preferred | PersonalAndLegalRelationshipRoleType | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​guardian.guardianPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.classCode | Base | required | RoleClassPassive | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.classCode | Base | required | EntityClassPlace | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​use | Base | required | CDAPostalAddressUse | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.delimiter.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country | Base | required | Country2 | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.country.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.state.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.county.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.city.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postalCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumber.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.houseNumberNumeric.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.direction.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetName.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameBase.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.streetNameType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.additionalLocator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitID.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.unitType.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.careOf.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.censusTract.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryAddressLine.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationType.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationArea.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryInstallationQualifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryMode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.deliveryModeIdentifier.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.buildingNumberSuffix.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.postBox.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​birthplace.place.addr.​item.precinct.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​languageCode | Base | required | Languages | 📦1.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​modeCode | Base | example | LanguageAbilityMode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.patient.​languageCommunication.​proficiencyLevelCode | Base | example | LanguageAbilityProficiency | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.recordTarget.​patientRole.providerOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​classCode | Base | required | EntityClassDevice | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​manufacturerModelName | Base | example | Manufacturer Model Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.author.​assignedAuthor.assignedAuthoringDevice.​softwareName | Base | example | Software Name Example | 📦2.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.dataEnterer.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.code | Base | example | NUCCProviderCodes | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:provider.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informant:non-provider.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.custodian.​assignedCustodian.representedCustodianOrganization.​telecom.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​typeCode | Base | required | x_InformationRecipient | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.informationRecipient.​intendedRecipient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.classCode | Base | required | CDAInformationRecipientRole | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.informationRecipient.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.informationRecipient.​intendedRecipient.receivedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.legalAuthenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode | Base | required | CDASignatureCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​signatureCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authenticator.​assignedEntity.assignedPerson.​sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.participant.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​typeCode | Base | required | ActRelationshipFulfills | 📍2.0.0 | THO v5.2 |
| ClinicalDocument.inFulfillmentOf.​order.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.moodCode | Base | required | CDAActMoodIntent | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.inFulfillmentOf.​order.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.inFulfillmentOf.​order.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​typeCode | Base | required | x_ServiceEventPerformer | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.documentationOf.​serviceEvent.performer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​typeCode | Base | required | ActRelationshipAuthorizedBy | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.authorization.​consent.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.authorization.​consent.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​classCode | Base | required | CDAActClass | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​code | Base | example | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​dischargeDispositionCode | Base | example | USEncounterDischargeDisposition | 📦3.0.0 | THO v6.5 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​responsibleParty.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ClinicalDocument.componentOf.​encompassingEncounter.​location.typeCode | Base | required | ParticipationTargetLocation | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 1198-8348 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty, ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). |
assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()
|
| 1198-32905 | error | ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). |
assignedPerson.exists() or representedOrganization.exists()
|
| 4537-6380 | error | ClinicalDocument | If setId is present versionNumber **SHALL** be present (CONF:4537-6380). |
setId.exists() implies versionNumber.exists()
|
| 4537-6387 | error | ClinicalDocument | If versionNumber is present setId **SHALL** be present (CONF:4537-6387). |
versionNumber.exists() implies setId.exists()
|
| 4537-10006 | error | ClinicalDocument.participant | **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). |
associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()
|
| 4537-16790 | error | ClinicalDocument.author.assignedAuthor | There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). |
(assignedPerson | assignedAuthoringDevice).count() = 1
|
| 4537-21000 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true |
sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
|
| 4537-32993 | error | ClinicalDocument.recordTarget.patientRole.patient | If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). |
sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
|
| AD-1 | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item | Can only have only one of the possible item elements in each choice |
(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
|
| II-1 | error | ClinicalDocument.typeId, ClinicalDocument.recordTarget.typeId, ClinicalDocument.recordTarget.patientRole.typeId, ClinicalDocument.recordTarget.patientRole.patient.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId, ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId, ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId, ClinicalDocument.author.typeId, ClinicalDocument.author.assignedAuthor.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.typeId, ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId, ClinicalDocument.dataEnterer.typeId, ClinicalDocument.dataEnterer.assignedEntity.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:provider.typeId, ClinicalDocument.informant:provider.assignedEntity.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.informant:non-provider.typeId, ClinicalDocument.custodian.typeId, ClinicalDocument.custodian.assignedCustodian.typeId, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId, ClinicalDocument.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId, ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId, ClinicalDocument.legalAuthenticator.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.authenticator.typeId, ClinicalDocument.authenticator.assignedEntity.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId, ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId, ClinicalDocument.participant.typeId, ClinicalDocument.inFulfillmentOf.typeId, ClinicalDocument.inFulfillmentOf.order.typeId, ClinicalDocument.documentationOf.typeId, ClinicalDocument.documentationOf.serviceEvent.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.typeId, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId, ClinicalDocument.authorization.typeId, ClinicalDocument.authorization.consent.typeId, ClinicalDocument.componentOf.typeId, ClinicalDocument.componentOf.encompassingEncounter.typeId, ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId, ClinicalDocument.componentOf.encompassingEncounter.location.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| ihe-pcc-person-name | error | ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| ihe-pcc-realmCode-1 | error | ClinicalDocument.realmCode.code | If realmCode is present it SHOULD be UV |
realmCode.code.exists() implies realmCode.code.exists(value=#UV)
|
| ihe-pcc-realmCode-2 | error | ClinicalDocument.templateId | If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 |
realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)
|
| iti-pdqm-patname | error | ClinicalDocument.recordTarget.patientRole.patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. |
(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| should-code-attr | warning | ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | SHOULD contain @code |
code.exists()
|
| should-country | warning | ClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:provider.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator.assignedEntity.addr | SHOULD contain country |
|
| should-legalAuthenticator | warning | ClinicalDocument | SHOULD contain legalAuthenticator |
legalAuthenticator.exists()
|
| should-maritalStatusCode | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain maritalStatusCode |
maritalStatusCode.exists()
|
| should-preferenceInd | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain preferenceInd |
preferenceInd.exists()
|
| should-proficiencyLevelCode | warning | ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | SHOULD contain proficiencyLevelCode |
proficiencyLevelCode.exists()
|
| should-relatedParticipant | warning | ClinicalDocument | Documents SHOULD contain a RelatedPerson participant |
AssociatedEntity.associatedPerson.exists()
|
| should-responsibleParty | warning | ClinicalDocument.componentOf.encompassingEncounter | SHOULD contain responsibleParty |
responsibleParty.exists()
|
| should-us-addr | warning | ClinicalDocument.recordTarget.patientRole.patient, ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain addr |
addr.exists()
|
| should-us-code | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian, ClinicalDocument.author.assignedAuthor, ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-us-languageCommunication | warning | ClinicalDocument.recordTarget.patientRole.patient | SHOULD contain languageCommunication |
languageCommunication.exists()
|
| should-us-performer | warning | ClinicalDocument.documentationOf.serviceEvent | SHOULD contain performer |
performer.exists()
|
| should-us-telecom | warning | ClinicalDocument.recordTarget.patientRole.patient.guardian | SHOULD contain telecom |
telecom.exists()
|
| should-use | warning | ClinicalDocument.recordTarget.patientRole.telecom, ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom, ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom, ClinicalDocument.author.assignedAuthor.telecom, ClinicalDocument.dataEnterer.assignedEntity.telecom, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom, ClinicalDocument.legalAuthenticator.assignedEntity.telecom, ClinicalDocument.authenticator.assignedEntity.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| should-value-att | warning | ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | SHOULD contain @value |
value.exists()
|
| signature | warning | ClinicalDocument.legalAuthenticator.signatureCode, ClinicalDocument.authenticator.signatureCode | CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. |
code.exists() implies code != 'X'
|
| text-null | error | ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox, ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct | xmlText and nullFlavor are mutually exclusive (one must be present) |
(xmlText | nullFlavor).count() = 1
|
| ts-shall-year | error | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHALL** be precise to at least the year |
nullFlavor.exists() or value.toString().length() >= 4
|
| ts-should-day | warning | ClinicalDocument.recordTarget.patientRole.patient.birthTime, ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | **SHOULD** be precise to at least the day |
nullFlavor.exists() or value.toString().length() >= 10
|
This structure is derived from ClinicalDocument
Summary
Mandatory: 24 elements(43 nested mandatory elements)
Must-Support: 97 elements
Prohibited: 4 elements
Slices
This structure defines the following Slices:
IG © 2023+ IHE Patient Care Coordination Technical Committee. Package ihe.pcc.pscc#0.0.1-current based on FHIR 5.0.0. Generated 2025-11-04
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change