Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Advance Directive Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation Version: 2.1
Draft as of 2023-09-29 Computable Name: AdvanceDirectiveObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2015-08-01

This clinical statement represents Advance Directive Observation findings (e.g., “resuscitation status is Full Code”) rather than orders. It should not be considered a legal document or a substitute for the actual Advance Directive document. The related legal documents are referenced using the reference/externalReference element.

The Advance Directive Observation describes the patient’s directives, including but not limited to:

  • Medications
  • Transfer of Care to Hospital
  • Treatment
  • Procedures
  • Intubation and Ventilation
  • Diagnostic Tests
  • Tests

The observation/value element contains the detailed patient directive which may be coded or text. For example, a category directive may be antibiotics, and the details would be intravenous antibiotics only.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... code 1..1csRequired Pattern: 75320-2
...... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... value C1..1ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
....... extension 0..0
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... typeCode 1..1csFixed Value: VRF
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... participantRole 1..1ParticipantRole
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... name 0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... participant:participant2 0..*Participant2
..... typeCode 1..1csFixed Value: CST
..... participantRole 1..1ParticipantRole
...... classCode 1..1csFixed Value: AGNT
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr 0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingEntity 1..1PlayingEntity
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... typeCode 1..1csFixed Value: REFR
..... externalDocument 1..1ExternalDocument
...... id 1..*II
...... text 0..1ED
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codepreferredAdvance Directive Type Code
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... @extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... @code 1..1csRequired Pattern: 75320-2
...... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
Binding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... value C1..11198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
..... participantRole 1..1ParticipantRole
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: VRF
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name C0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... participant:participant2 0..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CST
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: AGNT
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
..... externalDocument 1..1ExternalDocument
...... @classCode 1..1csBinding: ActClassDocument (required)
...... id 1..*II
...... text 0..1ED
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codepreferredAdvance Directive Type Code
Observation.statusCoderequiredActStatus
Observation.participant:participant1.typeCoderequiredFixed Value: VRF
Observation.participant:participant1.participantRole.classCoderequiredRoleClassRoot
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.typeCoderequiredFixed Value: CST
Observation.participant:participant2.participantRole.classCoderequiredFixed Value: AGNT
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier
Observation.reference:reference1.typeCoderequiredFixed Value: REFR
Observation.reference:reference1.externalDocument.classCoderequiredActClassDocument

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:
81-7296errorObservation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorObservation.participant:participant1.participantRole.playingEntity.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorObservation.participant:participant1.participantRole.playingEntity.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorObservation.participant:participant1.participantRole.playingEntity.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... @extension 1..1stRequired Pattern: 2015-08-01
... id 1..*II
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 0..1cs
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csRequired Pattern: 75320-2
...... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
...... @codeSystemName 0..1st
...... @codeSystemVersion 0..1st
...... @displayName 0..1st
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1ED
...... qualifier 0..*CR
...... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
Binding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C1..11198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: VRF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: EntityCode (extensible)
....... quantity 0..*PQ
....... name C0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
.... participant:participant2 0..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CST
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: AGNT
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... quantity 0..*PQ
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
..... seperatableInd 0..1BL
..... externalAct 0..1ExternalAct
..... externalObservation 0..1ExternalObservation
..... externalProcedure 0..1ExternalProcedure
..... externalDocument 1..1ExternalDocument
...... @classCode 1..1csBinding: ActClassDocument (required)
...... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
...... templateId 0..*II
...... id 1..*II
...... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
...... text 0..1ED
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @charset 0..1cs
....... @compression 0..1csBinding: CompressionAlgorithm (required)
....... @integrityCheck 0..1bin
....... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (required)
....... @language 0..1cs
....... @mediaType 0..1cs
....... @representation 0..1cs
....... data[x] 0..1
........ dataStringstring(st)
........ dataBase64Binarybase64Binary(bin)
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
....... thumbnail 0..1ED
...... setId 0..1II
...... versionNumber 0..1INT
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codepreferredAdvance Directive Type Code
Observation.code.nullFlavorrequiredNullFlavor
Observation.code.translation:advanceDirective.nullFlavorrequiredNullFlavor
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.participant.nullFlavorrequiredNullFlavor
Observation.participant.typeCoderequiredParticipationType
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.templateId:primary.nullFlavorrequiredNullFlavor
Observation.participant:participant1.nullFlavorrequiredNullFlavor
Observation.participant:participant1.typeCoderequiredFixed Value: VRF
Observation.participant:participant1.contextControlCoderequiredFixed Value: OP
Observation.participant:participant1.participantRole.classCoderequiredRoleClassRoot
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant1.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant1.participantRole.playingEntity.codeextensibleEntityCode
Observation.participant:participant2.nullFlavorrequiredNullFlavor
Observation.participant:participant2.typeCoderequiredFixed Value: CST
Observation.participant:participant2.contextControlCoderequiredFixed Value: OP
Observation.participant:participant2.participantRole.classCoderequiredFixed Value: AGNT
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier
Observation.reference:reference1.nullFlavorrequiredNullFlavor
Observation.reference:reference1.typeCoderequiredFixed Value: REFR
Observation.reference:reference1.externalDocument.classCoderequiredActClassDocument
Observation.reference:reference1.externalDocument.moodCoderequiredFixed Value: EVN
Observation.reference:reference1.externalDocument.codeextensibleFHIRDocumentTypeCodes
Observation.reference:reference1.externalDocument.text.nullFlavorrequiredNullFlavor
Observation.reference:reference1.externalDocument.text.compressionrequiredCompressionAlgorithm
Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:
81-7296errorObservation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorObservation.participant:participant1.participantRole.playingEntity.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorObservation.participant:participant1.participantRole.playingEntity.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorObservation.participant:participant1.participantRole.playingEntity.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from CDAR2.Observation

Summary

Mandatory: 19 elements (7 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension
  • The element Observation.code.translation is sliced based on the values of value:code, value:codeSystem
  • The element Observation.participant is sliced based on the values of value:participantRole, value:typeCode
  • The element Observation.participant.templateId is sliced based on the value of value:root
  • The element Observation.reference is sliced based on the values of value:externalDocument, value:typeCode

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... code 1..1csRequired Pattern: 75320-2
...... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... value C1..1ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
....... extension 0..0
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... typeCode 1..1csFixed Value: VRF
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... participantRole 1..1ParticipantRole
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... name 0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... participant:participant2 0..*Participant2
..... typeCode 1..1csFixed Value: CST
..... participantRole 1..1ParticipantRole
...... classCode 1..1csFixed Value: AGNT
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr 0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingEntity 1..1PlayingEntity
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... typeCode 1..1csFixed Value: REFR
..... externalDocument 1..1ExternalDocument
...... id 1..*II
...... text 0..1ED
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codepreferredAdvance Directive Type Code
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... @extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... @code 1..1csRequired Pattern: 75320-2
...... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
Binding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... value C1..11198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
..... participantRole 1..1ParticipantRole
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: VRF
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name C0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... participant:participant2 0..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CST
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: AGNT
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
..... externalDocument 1..1ExternalDocument
...... @classCode 1..1csBinding: ActClassDocument (required)
...... id 1..*II
...... text 0..1ED
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codepreferredAdvance Directive Type Code
Observation.statusCoderequiredActStatus
Observation.participant:participant1.typeCoderequiredFixed Value: VRF
Observation.participant:participant1.participantRole.classCoderequiredRoleClassRoot
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.typeCoderequiredFixed Value: CST
Observation.participant:participant2.participantRole.classCoderequiredFixed Value: AGNT
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier
Observation.reference:reference1.typeCoderequiredFixed Value: REFR
Observation.reference:reference1.externalDocument.classCoderequiredActClassDocument

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:
81-7296errorObservation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorObservation.participant:participant1.participantRole.playingEntity.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorObservation.participant:participant1.participantRole.playingEntity.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorObservation.participant:participant1.participantRole.playingEntity.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.48
..... @extension 1..1stRequired Pattern: 2015-08-01
... id 1..*II
... code 1..1CDBinding: Advance Directive Type Code (preferred)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 0..1cs
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... Slices for translation 1..*CDSlice: Unordered, Open by value:code, value:codeSystem
..... translation:advanceDirective 1..1CD
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csRequired Pattern: 75320-2
...... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
...... @codeSystemName 0..1st
...... @codeSystemVersion 0..1st
...... @displayName 0..1st
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1ED
...... qualifier 0..*CR
...... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSSG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB
Binding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high C1..1IVXB_TS1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C1..11198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... Slices for participant 0..*Participant2This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary.
Slice: Unordered, Open by value:participantRole, value:typeCode
.... participant:All Slices Content/Rules for all slices
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... Slices for templateId 1..*IISlice: Unordered, Open by value:root
...... templateId:primary 1..1II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.1.58
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
.... participant:participant1 0..*Participant2The participant "VRF" represents the clinician(s) who verified the patient advance directive observation.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: VRF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time C0..1IVL_TS1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: EntityCode (extensible)
....... quantity 0..*PQ
....... name C0..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
.... participant:participant2 0..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CST
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: AGNT
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Personal And Legal Relationship Role Type (preferred)
...... addr C0..1USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: Healthcare Agent Qualifier (preferred)
....... quantity 0..*PQ
....... name 1..1PNRecord the name of the agent who can provide a copy of the Advance Directive in the name element.
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... Slices for reference 1..*ReferenceSlice: Unordered, Open by value:externalDocument, value:typeCode
.... reference:reference1 1..*Reference
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
..... seperatableInd 0..1BL
..... externalAct 0..1ExternalAct
..... externalObservation 0..1ExternalObservation
..... externalProcedure 0..1ExternalProcedure
..... externalDocument 1..1ExternalDocument
...... @classCode 1..1csBinding: ActClassDocument (required)
...... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
...... templateId 0..*II
...... id 1..*II
...... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
...... text 0..1ED
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @charset 0..1cs
....... @compression 0..1csBinding: CompressionAlgorithm (required)
....... @integrityCheck 0..1bin
....... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (required)
....... @language 0..1cs
....... @mediaType 0..1cs
....... @representation 0..1cs
....... data[x] 0..1
........ dataStringstring(st)
........ dataBase64Binarybase64Binary(bin)
....... reference C0..1TEL1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
....... thumbnail 0..1ED
...... setId 0..1II
...... versionNumber 0..1INT
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codepreferredAdvance Directive Type Code
Observation.code.nullFlavorrequiredNullFlavor
Observation.code.translation:advanceDirective.nullFlavorrequiredNullFlavor
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.participant.nullFlavorrequiredNullFlavor
Observation.participant.typeCoderequiredParticipationType
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.templateId:primary.nullFlavorrequiredNullFlavor
Observation.participant:participant1.nullFlavorrequiredNullFlavor
Observation.participant:participant1.typeCoderequiredFixed Value: VRF
Observation.participant:participant1.contextControlCoderequiredFixed Value: OP
Observation.participant:participant1.participantRole.classCoderequiredRoleClassRoot
Observation.participant:participant1.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant1.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant1.participantRole.playingEntity.codeextensibleEntityCode
Observation.participant:participant2.nullFlavorrequiredNullFlavor
Observation.participant:participant2.typeCoderequiredFixed Value: CST
Observation.participant:participant2.contextControlCoderequiredFixed Value: OP
Observation.participant:participant2.participantRole.classCoderequiredFixed Value: AGNT
Observation.participant:participant2.participantRole.codepreferredPersonal And Legal Relationship Role Type
Observation.participant:participant2.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant:participant2.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant2.participantRole.playingEntity.codepreferredHealthcare Agent Qualifier
Observation.reference:reference1.nullFlavorrequiredNullFlavor
Observation.reference:reference1.typeCoderequiredFixed Value: REFR
Observation.reference:reference1.externalDocument.classCoderequiredActClassDocument
Observation.reference:reference1.externalDocument.moodCoderequiredFixed Value: EVN
Observation.reference:reference1.externalDocument.codeextensibleFHIRDocumentTypeCodes
Observation.reference:reference1.externalDocument.text.nullFlavorrequiredNullFlavor
Observation.reference:reference1.externalDocument.text.compressionrequiredCompressionAlgorithm
Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1198-8666warningObservation.participant:participant1.timeThe data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666).
:
1198-8698warningObservation.reference:reference1.externalDocument.text.referenceThe URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).
:
1198-8699warningObservation.reference:reference1.externalDocument.text.referenceIf a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).
:
1198-32449errorObservation.effectiveTime.highIf the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).
:
1198-32493errorObservation.valueIf type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493).
:
81-7296errorObservation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorObservation.participant:participant1.participantRole.playingEntity.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorObservation.participant:participant1.participantRole.playingEntity.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorObservation.participant:participant1.participantRole.playingEntity.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from CDAR2.Observation

Summary

Mandatory: 19 elements (7 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension
  • The element Observation.code.translation is sliced based on the values of value:code, value:codeSystem
  • The element Observation.participant is sliced based on the values of value:participantRole, value:typeCode
  • The element Observation.participant.templateId is sliced based on the value of value:root
  • The element Observation.reference is sliced based on the values of value:externalDocument, value:typeCode

 

Other representations of profile: CSV, Excel