Advance Healthcare Directive Interoperability (cda-adi)
0.1.0 - ci-build

Advance Healthcare Directive Interoperability (cda-adi), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-adi/ and changes regularly. See the Directory of published versions

Logical Model: Agent Appointment Part of the ADI Healthcare Agent Consent Entry

Official URL: http://hl7.org/cda/us/adi/StructureDefinition/Agent.Appointment.Part Version: 0.1.0
Draft as of 2026-02-01 Computable Name: Agent_Appointment_Part

This entry part includes the info about who was apointed a healthcare agent and their ordinal role.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... code
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... participant 1..1 Participant2
.... @typeCode 1..1 cs Use NOT for person to be notified
.... participantRole
..... @classCode 0..1 cs Required Pattern: AGNT
..... code
...... @code 0..1 cs Binding: Personal And Legal Relationship Role Type . (extensible)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingEntity 1..1 PlayingEntity
...... code S 0..1 CE
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
...... name S 0..* PN

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... @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 Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id 0..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CD Binding: ObservationType (3.0.0) (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
.... @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
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (3.0.0) (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 0..*
.... value ANY
.... value BL
.... value ED
.... value ST
.... value CD
.... value CV
.... value CE
.... value CO
.... value SC
.... value II
.... value TEL
.... value AD
.... value EN
.... value INT
.... value REAL
.... value PQ
.... value MO
.... value TS
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (3.0.0) (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 1..1 Participant2
.... @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 Use NOT for person to be notified
Binding: CDAParticipationType (required)
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole 1..1 ParticipantRole
..... @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: CDARoleClassRoot (required)
Required Pattern: AGNT
..... id 0..* 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 Binding: Personal And Legal Relationship Role Type . (extensible)
...... @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 S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @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: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (example)
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
....... @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
...... quantity 0..* PQ
...... name S 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* 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: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
Observation.code Base example ObservationType 📍3.0.0 THO v6.5
Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.statusCode Base required ActStatus 📍3.0.0 THO v6.5
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v6.5
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v6.5
Observation.participant.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
II-1 error Observation.typeId, Observation.participant.typeId, Observation.participant.participantRole.typeId, Observation.participant.participantRole.playingEntity.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... @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 Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id 0..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CD Binding: ObservationType (3.0.0) (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
.... @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
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (3.0.0) (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 0..*
.... value ANY
.... value BL
.... value ED
.... value ST
.... value CD
.... value CV
.... value CE
.... value CO
.... value SC
.... value II
.... value TEL
.... value AD
.... value EN
.... value INT
.... value REAL
.... value PQ
.... value MO
.... value TS
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (3.0.0) (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 1..1 Participant2
.... @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 Use NOT for person to be notified
Binding: CDAParticipationType (required)
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole 1..1 ParticipantRole
..... @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: CDARoleClassRoot (required)
Required Pattern: AGNT
..... id 0..* 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 Binding: Personal And Legal Relationship Role Type . (extensible)
...... @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 S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @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: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (example)
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
....... @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
...... quantity 0..* PQ
...... name S 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* 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: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
Observation.code Base example ObservationType 📍3.0.0 THO v6.5
Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.statusCode Base required ActStatus 📍3.0.0 THO v6.5
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v6.5
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v6.5
Observation.participant.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
II-1 error Observation.typeId, Observation.participant.typeId, Observation.participant.participantRole.typeId, Observation.participant.participantRole.playingEntity.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from Observation

Summary

Mandatory: 2 elements
Must-Support: 4 elements

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... code
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... participant 1..1 Participant2
.... @typeCode 1..1 cs Use NOT for person to be notified
.... participantRole
..... @classCode 0..1 cs Required Pattern: AGNT
..... code
...... @code 0..1 cs Binding: Personal And Legal Relationship Role Type . (extensible)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingEntity 1..1 PlayingEntity
...... code S 0..1 CE
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
...... name S 0..* PN

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... @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 Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id 0..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CD Binding: ObservationType (3.0.0) (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
.... @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
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (3.0.0) (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 0..*
.... value ANY
.... value BL
.... value ED
.... value ST
.... value CD
.... value CV
.... value CE
.... value CO
.... value SC
.... value II
.... value TEL
.... value AD
.... value EN
.... value INT
.... value REAL
.... value PQ
.... value MO
.... value TS
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (3.0.0) (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 1..1 Participant2
.... @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 Use NOT for person to be notified
Binding: CDAParticipationType (required)
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole 1..1 ParticipantRole
..... @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: CDARoleClassRoot (required)
Required Pattern: AGNT
..... id 0..* 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 Binding: Personal And Legal Relationship Role Type . (extensible)
...... @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 S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @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: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (example)
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
....... @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
...... quantity 0..* PQ
...... name S 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* 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: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
Observation.code Base example ObservationType 📍3.0.0 THO v6.5
Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.statusCode Base required ActStatus 📍3.0.0 THO v6.5
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v6.5
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v6.5
Observation.participant.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
II-1 error Observation.typeId, Observation.participant.typeId, Observation.participant.participantRole.typeId, Observation.participant.participantRole.playingEntity.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation 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)
... @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 Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id 0..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CD Binding: ObservationType (3.0.0) (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Binding: Healthcare Agent or Proxy Choices . (required)
.... @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
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED links to the rendering of a participating Healthcare Agent
... statusCode 0..1 CS Binding: ActStatus (3.0.0) (required)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (3.0.0) (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 0..*
.... value ANY
.... value BL
.... value ED
.... value ST
.... value CD
.... value CV
.... value CE
.... value CO
.... value SC
.... value II
.... value TEL
.... value AD
.... value EN
.... value INT
.... value REAL
.... value PQ
.... value MO
.... value TS
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (3.0.0) (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 1..1 Participant2
.... @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 Use NOT for person to be notified
Binding: CDAParticipationType (required)
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole 1..1 ParticipantRole
..... @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: CDARoleClassRoot (required)
Required Pattern: AGNT
..... id 0..* 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 Binding: Personal And Legal Relationship Role Type . (extensible)
...... @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 S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @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: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (example)
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @code 0..1 cs Binding: Healthcare Agent Ordinality . (required)
....... @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
...... quantity 0..* PQ
...... name S 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* 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: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
Observation.code Base example ObservationType 📍3.0.0 THO v6.5
Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . 📦20221029 VSAC v0.23
Observation.statusCode Base required ActStatus 📍3.0.0 THO v6.5
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v6.5
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v6.5
Observation.participant.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . 📦20240606 VSAC v0.23
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v6.5
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . 📦20201204 VSAC v0.23
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

Constraints

Id Grade Path(s) Description Expression
II-1 error Observation.typeId, Observation.participant.typeId, Observation.participant.participantRole.typeId, Observation.participant.participantRole.playingEntity.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from Observation

Summary

Mandatory: 2 elements
Must-Support: 4 elements

 

Other representations of profile: CSV, Excel