International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPS Advance Directive Observation

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.37--20200508162154 Version: 1.0
Draft as of 2020-05-08 Computable Name: IPSAdvanceDirectiveObservation
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.37 (use: OFFICIAL)

This clinical statement represents Advance Directive Observation findings (e.g., “resuscitation status is Full Code”.html) 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 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeFixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... statusCode S1..1CS
.... code 0..1stringFixed Value: completed
... effectiveTime S1..1IVL_TS
.... low S1..1TS
.... high S1..1TS
... value S1..1BL, ED, ED, 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_PQ
... author S0..*Author
... participant 0..*Participant2
.... typeCode 1..1codeFixed Value: VRF
.... time S0..1IVL_TS
.... participantRole S1..1ParticipantRole
..... code S0..1CE
..... addr S0..*AD
..... playingEntity 0..1PlayingEntity
...... code S0..1CE
...... name S1..1EN
... reference S0..*Element
.... typeCode 1..1codeFixed Value: REFR
.... externalDocument S1..1ExternalDocument
..... id S1..*II
..... text 0..1ED
...... reference 0..1TEL

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeexampleAdvanceDirectiveTypeCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... statusCode S1..1CSBinding: ActStatus (required)
.... code 0..1stringFixed Value: completed
... effectiveTime S1..1IVL_TS
.... low S1..1TS
.... high S1..1TS
... value S1..1
.... valueBL
.... valueED
.... valueED
.... 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 S0..*Author
... participant 0..*Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: VRF
.... time S0..1IVL_TS
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... code S0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S0..*AD
..... playingEntity 0..1PlayingEntity
...... classCode 1..1codeBinding: EntityClassRoot (required)
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S0..1CEBinding: EntityCode (extensible)
...... name S1..1EN
... reference S0..*Element
.... typeCode 1..1codeFixed Value: REFR
.... externalDocument S1..1ExternalDocument
..... classCode 1..1codeBinding: ActClassDocument (required)
..... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
..... id S1..*II
..... text 0..1ED
...... reference 0..1TEL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeexampleAdvanceDirectiveTypeCode
Observation.statusCoderequiredActStatus
Observation.participant.typeCoderequiredFixed Value: VRF
Observation.participant.participantRole.classCoderequiredRoleClassRoot
Observation.participant.participantRole.codeextensibleRoleCode
Observation.participant.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant.participantRole.playingEntity.codeextensibleEntityCode
Observation.reference.externalDocument.classCoderequiredActClassDocument
Observation.reference.externalDocument.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... derivationExpr 0..1ED
... text 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: completed
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime S1..1IVL_TS
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... value 0..1dateTime
.... inclusive 0..1boolean
.... operator 0..1code
.... low S1..1TS
.... high S1..1TS
.... width 0..1PQ
.... center 0..1TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value S1..1
.... valueBL
.... valueED
.... valueED
.... 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..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author S0..*Author
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: VRF
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time S0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code S0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
...... classCode 1..1codeBinding: EntityClassRoot (required)
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S0..1CEBinding: EntityCode (extensible)
...... quantity 0..*PQ
...... name S1..1EN
...... desc 0..1ED
..... scopingEntity 0..1Entity
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference S0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument S1..1ExternalDocument
..... classCode 1..1codeBinding: ActClassDocument (required)
..... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id S1..*II
..... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... text 0..1ED
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... charset 0..1code
...... compression 0..1codeBinding: CompressionAlgorithm (required)
...... integrityCheck 0..1base64Binary
...... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
...... language 0..1code
...... mediaType 0..1code
...... representation 0..1code
...... data[x] 0..1
....... dataStringstring
....... dataBase64Binarybase64Binary
...... reference 0..1TEL
...... thumbnail 0..1ED
..... setId 0..1II
..... versionNumber 0..1INT
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: 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.codeexampleAdvanceDirectiveTypeCode
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.subject.typeCoderequiredFixed Value: SBJ
Observation.subject.contextControlCoderequiredFixed Value: OP
Observation.subject.awarenessCodeextensibleTargetAwareness
Observation.informant.typeCoderequiredFixed Value: INF
Observation.informant.contextControlCoderequiredFixed Value: OP
Observation.participant.nullFlavorrequiredNullFlavor
Observation.participant.typeCoderequiredFixed Value: VRF
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.participantRole.classCoderequiredRoleClassRoot
Observation.participant.participantRole.codeextensibleRoleCode
Observation.participant.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant.participantRole.playingEntity.codeextensibleEntityCode
Observation.reference.externalDocument.classCoderequiredActClassDocument
Observation.reference.externalDocument.moodCoderequiredFixed Value: EVN
Observation.reference.externalDocument.codeextensibleFHIRDocumentTypeCodes
Observation.reference.externalDocument.text.nullFlavorrequiredNullFlavor
Observation.reference.externalDocument.text.compressionrequiredCompressionAlgorithm
Observation.reference.externalDocument.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorObservation.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Observation

Summary

Mandatory: 10 elements (6 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 6 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeFixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... statusCode S1..1CS
.... code 0..1stringFixed Value: completed
... effectiveTime S1..1IVL_TS
.... low S1..1TS
.... high S1..1TS
... value S1..1BL, ED, ED, 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_PQ
... author S0..*Author
... participant 0..*Participant2
.... typeCode 1..1codeFixed Value: VRF
.... time S0..1IVL_TS
.... participantRole S1..1ParticipantRole
..... code S0..1CE
..... addr S0..*AD
..... playingEntity 0..1PlayingEntity
...... code S0..1CE
...... name S1..1EN
... reference S0..*Element
.... typeCode 1..1codeFixed Value: REFR
.... externalDocument S1..1ExternalDocument
..... id S1..*II
..... text 0..1ED
...... reference 0..1TEL

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeexampleAdvanceDirectiveTypeCode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... statusCode S1..1CSBinding: ActStatus (required)
.... code 0..1stringFixed Value: completed
... effectiveTime S1..1IVL_TS
.... low S1..1TS
.... high S1..1TS
... value S1..1
.... valueBL
.... valueED
.... valueED
.... 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 S0..*Author
... participant 0..*Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: VRF
.... time S0..1IVL_TS
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... code S0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S0..*AD
..... playingEntity 0..1PlayingEntity
...... classCode 1..1codeBinding: EntityClassRoot (required)
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S0..1CEBinding: EntityCode (extensible)
...... name S1..1EN
... reference S0..*Element
.... typeCode 1..1codeFixed Value: REFR
.... externalDocument S1..1ExternalDocument
..... classCode 1..1codeBinding: ActClassDocument (required)
..... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
..... id S1..*II
..... text 0..1ED
...... reference 0..1TEL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeexampleAdvanceDirectiveTypeCode
Observation.statusCoderequiredActStatus
Observation.participant.typeCoderequiredFixed Value: VRF
Observation.participant.participantRole.classCoderequiredRoleClassRoot
Observation.participant.participantRole.codeextensibleRoleCode
Observation.participant.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant.participantRole.playingEntity.codeextensibleEntityCode
Observation.reference.externalDocument.classCoderequiredActClassDocument
Observation.reference.externalDocument.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeFixed Value: EVN
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.37
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: AdvanceDirectiveTypeCode (example): AdvanceDirectiveTypeCode

... derivationExpr 0..1ED
... text 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: completed
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime S1..1IVL_TS
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... value 0..1dateTime
.... inclusive 0..1boolean
.... operator 0..1code
.... low S1..1TS
.... high S1..1TS
.... width 0..1PQ
.... center 0..1TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value S1..1
.... valueBL
.... valueED
.... valueED
.... 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..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author S0..*Author
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: VRF
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time S0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code S0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
...... classCode 1..1codeBinding: EntityClassRoot (required)
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S0..1CEBinding: EntityCode (extensible)
...... quantity 0..*PQ
...... name S1..1EN
...... desc 0..1ED
..... scopingEntity 0..1Entity
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference S0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument S1..1ExternalDocument
..... classCode 1..1codeBinding: ActClassDocument (required)
..... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id S1..*II
..... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... text 0..1ED
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... charset 0..1code
...... compression 0..1codeBinding: CompressionAlgorithm (required)
...... integrityCheck 0..1base64Binary
...... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
...... language 0..1code
...... mediaType 0..1code
...... representation 0..1code
...... data[x] 0..1
....... dataStringstring
....... dataBase64Binarybase64Binary
...... reference 0..1TEL
...... thumbnail 0..1ED
..... setId 0..1II
..... versionNumber 0..1INT
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: 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.codeexampleAdvanceDirectiveTypeCode
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.subject.typeCoderequiredFixed Value: SBJ
Observation.subject.contextControlCoderequiredFixed Value: OP
Observation.subject.awarenessCodeextensibleTargetAwareness
Observation.informant.typeCoderequiredFixed Value: INF
Observation.informant.contextControlCoderequiredFixed Value: OP
Observation.participant.nullFlavorrequiredNullFlavor
Observation.participant.typeCoderequiredFixed Value: VRF
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.participantRole.classCoderequiredRoleClassRoot
Observation.participant.participantRole.codeextensibleRoleCode
Observation.participant.participantRole.playingEntity.classCoderequiredEntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant.participantRole.playingEntity.codeextensibleEntityCode
Observation.reference.externalDocument.classCoderequiredActClassDocument
Observation.reference.externalDocument.moodCoderequiredFixed Value: EVN
Observation.reference.externalDocument.codeextensibleFHIRDocumentTypeCodes
Observation.reference.externalDocument.text.nullFlavorrequiredNullFlavor
Observation.reference.externalDocument.text.compressionrequiredCompressionAlgorithm
Observation.reference.externalDocument.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorObservation.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Observation

Summary

Mandatory: 10 elements (6 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 6 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel, Schematron