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/AgentAppointmentPart Version: 0.1.0
Draft as of 2026-06-19 Computable Name: Agent_Appointment_Part
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.4.823.1.4.2.1:2026-08-28

Sub-part of the ADI Healthcare Agent Consent Entry. This entry part includes the info about who was apointed a healthcare agent and their ordinal role. This entry is not intended to be used as a complete clinical statement entry on its own.

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(2.0.3-sd) 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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... code
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
... participant 1..1 Participant2
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
.... participantRole
..... @classCode 0..1 cs(2.0.3-sd) Required Pattern: AGNT
..... code
...... @code 0..1 cs(2.0.3-sd) 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(2.0.3-sd) 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 tx.fhir.org
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @assigningAuthorityName 0..1 st(2.0.3-sd)
.... @displayable 0..1 bl(2.0.3-sd)
.... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st(2.0.3-sd)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... @classCode 1..1 cs(2.0.3-sd) Binding: CDAActClassObservation (2.0.3-sd) (required)
... @moodCode 1..1 cs(2.0.3-sd) Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl(2.0.3-sd)
... 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
.... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
.... @codeSystemName 0..1 st(2.0.3-sd)
.... @codeSystemVersion 0..1 st(2.0.3-sd)
.... @displayName 0..1 st(2.0.3-sd)
.... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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
... 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 CD
.... value PQ
.... value ST
.... value AD
.... value BL
.... value CE
.... value CO
.... value CS
.... value CV
.... value ED
.... value EN
.... value II
.... value INT
.... value INT_POS
.... value MO
.... value ON
.... value PN
.... value REAL
.... value SC
.... value TEL
.... value TN
.... value TS
.... value IVL_INT
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
Binding: CDAParticipationType (2.0.3-sd) (required)
.... @contextControlCode 0..1 cs(2.0.3-sd) Binding: CDAContextControl (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... realmCode 0..* CS
..... typeId C 0..1 II Constraints: II-1
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @assigningAuthorityName 0..1 st(2.0.3-sd)
...... @displayable 0..1 bl(2.0.3-sd)
...... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st(2.0.3-sd)
..... templateId 0..* II
..... @classCode 0..1 cs(2.0.3-sd) Binding: CDARoleClassRoot (2.0.3-sd) (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 (2.0.3-sd) (example)
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @code 0..1 cs(2.0.3-sd) Binding: Personal And Legal Relationship Role Type . (extensible)
...... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
...... @codeSystemName 0..1 st(2.0.3-sd)
...... @codeSystemVersion 0..1 st(2.0.3-sd)
...... @displayName 0..1 st(2.0.3-sd)
...... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
XML: specialty (urn:hl7-org:sdtc)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... realmCode 0..* CS
...... typeId C 0..1 II Constraints: II-1
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @assigningAuthorityName 0..1 st(2.0.3-sd)
....... @displayable 0..1 bl(2.0.3-sd)
....... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st(2.0.3-sd)
...... templateId 0..* II
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent Ordinality . (required)
....... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
....... @codeSystemName 0..1 st(2.0.3-sd)
....... @codeSystemVersion 0..1 st(2.0.3-sd)
....... @displayName 0..1 st(2.0.3-sd)
....... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 0..1 cs(2.0.3-sd) Binding: CDAActRelationshipType (2.0.3-sd) (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.3-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.templateId:agent-appointment-part.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📍2.0.3-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 v7.1
Observation.code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . ⏿20221029 tx.fhir.org
Observation.statusCode Base required ActStatus 📍3.0.0 THO v7.1
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v7.1
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v7.1
Observation.participant.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📍2.0.3-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(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @assigningAuthorityName 0..1 st(2.0.3-sd)
.... @displayable 0..1 bl(2.0.3-sd)
.... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st(2.0.3-sd)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... @classCode 1..1 cs(2.0.3-sd) Binding: CDAActClassObservation (2.0.3-sd) (required)
... @moodCode 1..1 cs(2.0.3-sd) Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl(2.0.3-sd)
... 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
.... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
.... @codeSystemName 0..1 st(2.0.3-sd)
.... @codeSystemVersion 0..1 st(2.0.3-sd)
.... @displayName 0..1 st(2.0.3-sd)
.... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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
... 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 CD
.... value PQ
.... value ST
.... value AD
.... value BL
.... value CE
.... value CO
.... value CS
.... value CV
.... value ED
.... value EN
.... value II
.... value INT
.... value INT_POS
.... value MO
.... value ON
.... value PN
.... value REAL
.... value SC
.... value TEL
.... value TN
.... value TS
.... value IVL_INT
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
Binding: CDAParticipationType (2.0.3-sd) (required)
.... @contextControlCode 0..1 cs(2.0.3-sd) Binding: CDAContextControl (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... realmCode 0..* CS
..... typeId C 0..1 II Constraints: II-1
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @assigningAuthorityName 0..1 st(2.0.3-sd)
...... @displayable 0..1 bl(2.0.3-sd)
...... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st(2.0.3-sd)
..... templateId 0..* II
..... @classCode 0..1 cs(2.0.3-sd) Binding: CDARoleClassRoot (2.0.3-sd) (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 (2.0.3-sd) (example)
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @code 0..1 cs(2.0.3-sd) Binding: Personal And Legal Relationship Role Type . (extensible)
...... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
...... @codeSystemName 0..1 st(2.0.3-sd)
...... @codeSystemVersion 0..1 st(2.0.3-sd)
...... @displayName 0..1 st(2.0.3-sd)
...... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
XML: specialty (urn:hl7-org:sdtc)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... realmCode 0..* CS
...... typeId C 0..1 II Constraints: II-1
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @assigningAuthorityName 0..1 st(2.0.3-sd)
....... @displayable 0..1 bl(2.0.3-sd)
....... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st(2.0.3-sd)
...... templateId 0..* II
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent Ordinality . (required)
....... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
....... @codeSystemName 0..1 st(2.0.3-sd)
....... @codeSystemVersion 0..1 st(2.0.3-sd)
....... @displayName 0..1 st(2.0.3-sd)
....... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 0..1 cs(2.0.3-sd) Binding: CDAActRelationshipType (2.0.3-sd) (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.3-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.templateId:agent-appointment-part.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📍2.0.3-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 v7.1
Observation.code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . ⏿20221029 tx.fhir.org
Observation.statusCode Base required ActStatus 📍3.0.0 THO v7.1
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v7.1
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v7.1
Observation.participant.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📍2.0.3-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: 6 elements
Must-Support: 4 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.templateId

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation(2.0.3-sd) 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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... code
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
... participant 1..1 Participant2
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
.... participantRole
..... @classCode 0..1 cs(2.0.3-sd) Required Pattern: AGNT
..... code
...... @code 0..1 cs(2.0.3-sd) 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(2.0.3-sd) 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 tx.fhir.org
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 1..1 Observation(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @assigningAuthorityName 0..1 st(2.0.3-sd)
.... @displayable 0..1 bl(2.0.3-sd)
.... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st(2.0.3-sd)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... @classCode 1..1 cs(2.0.3-sd) Binding: CDAActClassObservation (2.0.3-sd) (required)
... @moodCode 1..1 cs(2.0.3-sd) Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl(2.0.3-sd)
... 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
.... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
.... @codeSystemName 0..1 st(2.0.3-sd)
.... @codeSystemVersion 0..1 st(2.0.3-sd)
.... @displayName 0..1 st(2.0.3-sd)
.... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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
... 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 CD
.... value PQ
.... value ST
.... value AD
.... value BL
.... value CE
.... value CO
.... value CS
.... value CV
.... value ED
.... value EN
.... value II
.... value INT
.... value INT_POS
.... value MO
.... value ON
.... value PN
.... value REAL
.... value SC
.... value TEL
.... value TN
.... value TS
.... value IVL_INT
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
Binding: CDAParticipationType (2.0.3-sd) (required)
.... @contextControlCode 0..1 cs(2.0.3-sd) Binding: CDAContextControl (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... realmCode 0..* CS
..... typeId C 0..1 II Constraints: II-1
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @assigningAuthorityName 0..1 st(2.0.3-sd)
...... @displayable 0..1 bl(2.0.3-sd)
...... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st(2.0.3-sd)
..... templateId 0..* II
..... @classCode 0..1 cs(2.0.3-sd) Binding: CDARoleClassRoot (2.0.3-sd) (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 (2.0.3-sd) (example)
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @code 0..1 cs(2.0.3-sd) Binding: Personal And Legal Relationship Role Type . (extensible)
...... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
...... @codeSystemName 0..1 st(2.0.3-sd)
...... @codeSystemVersion 0..1 st(2.0.3-sd)
...... @displayName 0..1 st(2.0.3-sd)
...... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
XML: specialty (urn:hl7-org:sdtc)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... realmCode 0..* CS
...... typeId C 0..1 II Constraints: II-1
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @assigningAuthorityName 0..1 st(2.0.3-sd)
....... @displayable 0..1 bl(2.0.3-sd)
....... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st(2.0.3-sd)
...... templateId 0..* II
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent Ordinality . (required)
....... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
....... @codeSystemName 0..1 st(2.0.3-sd)
....... @codeSystemVersion 0..1 st(2.0.3-sd)
....... @displayName 0..1 st(2.0.3-sd)
....... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 0..1 cs(2.0.3-sd) Binding: CDAActRelationshipType (2.0.3-sd) (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.3-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.templateId:agent-appointment-part.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📍2.0.3-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 v7.1
Observation.code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . ⏿20221029 tx.fhir.org
Observation.statusCode Base required ActStatus 📍3.0.0 THO v7.1
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v7.1
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v7.1
Observation.participant.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📍2.0.3-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(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @assigningAuthorityName 0..1 st(2.0.3-sd)
.... @displayable 0..1 bl(2.0.3-sd)
.... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st(2.0.3-sd)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:agent-appointment-part 1..1 II
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Required Pattern: 2.16.840.1.113883.4.823.1.4.2.1
..... @extension 1..1 st(2.0.3-sd) Required Pattern: 2026-08-28
... @classCode 1..1 cs(2.0.3-sd) Binding: CDAActClassObservation (2.0.3-sd) (required)
... @moodCode 1..1 cs(2.0.3-sd) Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl(2.0.3-sd)
... 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent or Proxy Choices . (required)
.... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
.... @codeSystemName 0..1 st(2.0.3-sd)
.... @codeSystemVersion 0..1 st(2.0.3-sd)
.... @displayName 0..1 st(2.0.3-sd)
.... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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
... 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 CD
.... value PQ
.... value ST
.... value AD
.... value BL
.... value CE
.... value CO
.... value CS
.... value CV
.... value ED
.... value EN
.... value II
.... value INT
.... value INT_POS
.... value MO
.... value ON
.... value PN
.... value REAL
.... value SC
.... value TEL
.... value TN
.... value TS
.... value IVL_INT
.... value IVL_PQ
.... value IVL_TS
.... value PIVL_TS
.... value EIVL_TS
.... value SXPR_TS
.... value RTO_PQ_PQ
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 1..1 cs(2.0.3-sd) Use NOT for person to be notified
Binding: CDAParticipationType (2.0.3-sd) (required)
.... @contextControlCode 0..1 cs(2.0.3-sd) Binding: CDAContextControl (2.0.3-sd) (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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... realmCode 0..* CS
..... typeId C 0..1 II Constraints: II-1
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @assigningAuthorityName 0..1 st(2.0.3-sd)
...... @displayable 0..1 bl(2.0.3-sd)
...... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st(2.0.3-sd)
..... templateId 0..* II
..... @classCode 0..1 cs(2.0.3-sd) Binding: CDARoleClassRoot (2.0.3-sd) (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 (2.0.3-sd) (example)
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... @code 0..1 cs(2.0.3-sd) Binding: Personal And Legal Relationship Role Type . (extensible)
...... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
...... @codeSystemName 0..1 st(2.0.3-sd)
...... @codeSystemVersion 0..1 st(2.0.3-sd)
...... @displayName 0..1 st(2.0.3-sd)
...... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
XML: specialty (urn:hl7-org:sdtc)
..... addr S 0..* AD
..... telecom S 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity 1..1 PlayingEntity
...... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
...... realmCode 0..* CS
...... typeId C 0..1 II Constraints: II-1
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @assigningAuthorityName 0..1 st(2.0.3-sd)
....... @displayable 0..1 bl(2.0.3-sd)
....... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st(2.0.3-sd)
...... templateId 0..* II
...... @classCode 0..1 cs(2.0.3-sd) Binding: EntityClassRoot (3.0.0) (required)
...... @determinerCode 0..1 cs(2.0.3-sd) Binding: EntityDeterminer (3.0.0) (required)
Fixed Value: INSTANCE
...... code S 0..1 CE Binding: CDAEntityCode (2.0.3-sd) (example)
....... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
....... @code 0..1 cs(2.0.3-sd) Binding: Healthcare Agent Ordinality . (required)
....... @codeSystem 0..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd)
....... @codeSystemName 0..1 st(2.0.3-sd)
....... @codeSystemVersion 0..1 st(2.0.3-sd)
....... @displayName 0..1 st(2.0.3-sd)
....... @sdtcValueSet 0..1 oid(2.0.3-sd) XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1 st(2.0.3-sd) 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(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs(2.0.3-sd) Binding: CDANullFlavor (2.0.3-sd) (required)
..... @assigningAuthorityName 0..1 st(2.0.3-sd)
..... @displayable 0..1 bl(2.0.3-sd)
..... @root 1..1 oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st(2.0.3-sd)
.... templateId 0..* II
.... @typeCode 0..1 cs(2.0.3-sd) Binding: CDAActRelationshipType (2.0.3-sd) (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.3-sd Clinical Document Architecture v2.0
Observation.typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.templateId:agent-appointment-part.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.classCode Base required CDAActClassObservation 📍2.0.3-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 v7.1
Observation.code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.code.code Base required Healthcare Agent or Proxy Choices . ⏿20221029 tx.fhir.org
Observation.statusCode Base required ActStatus 📍3.0.0 THO v7.1
Observation.priorityCode Base example ActPriority 📍3.0.0 THO v7.1
Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
Observation.interpretationCode Base required CDAObservationInterpretation 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.methodCode Base example ObservationMethod 📍3.0.0 THO v7.1
Observation.participant.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​typeCode Base required CDAParticipationType 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​contextControlCode Base required CDAContextControl 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.classCode Base required CDARoleClassRoot 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code Base example CDARoleCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.code.​code Base extensible Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org
Observation.participant.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📍3.0.0 THO v7.1
Observation.participant.​participantRole.playingEntity.​code Base example CDAEntityCode 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.participant.​participantRole.playingEntity.​code.code Base required Healthcare Agent Ordinality . ⏿20201204 tx.fhir.org
Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📍2.0.3-sd Clinical Document Architecture v2.0
Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📍2.0.3-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: 6 elements
Must-Support: 4 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.templateId

 

Other representations of profile: CSV, Excel