Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Priority Preference

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference Version: 4.0.0
Draft as of 2025-10-02 Computable Name: PriorityPreference
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.143

This template represents priority preferences chosen by a patient or a care provider. Priority preferences are choices made by care providers or patients or both relative to options for care or treatment (including scheduling, care experience, and meeting of personal health goals), the sharing and disclosure of health information, and the prioritization of concerns and problems.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ..... @extension 0..0
    ... @classCode 1..1 cs Fixed Value: OBS
    ... @moodCode 1..1 cs Fixed Value: EVN
    ... code 1..1 CD
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... effectiveTime 0..1 IVL_TS
    ... value 1..1 CD Binding: Priority Level . (required)
    ... author 0..* AuthorParticipation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 0..1 CS Binding: ActStatus (required)
    ... effectiveTime 0..1 IVL_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD Binding: Priority Level . (required)
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author 0..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..* EntryRelationship
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.templateId:priority-pref.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v6.5
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v6.5
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Observation.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 0..1 CS Binding: ActStatus (required)
    ... effectiveTime 0..1 IVL_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD Binding: Priority Level . (required)
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author 0..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..* EntryRelationship
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.templateId:priority-pref.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v6.5
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v6.5
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Observation.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Observation

    Summary

    Mandatory: 7 elements
    Fixed: 2 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.templateId

    Differential View

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ..... @extension 0..0
    ... @classCode 1..1 cs Fixed Value: OBS
    ... @moodCode 1..1 cs Fixed Value: EVN
    ... code 1..1 CD
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... effectiveTime 0..1 IVL_TS
    ... value 1..1 CD Binding: Priority Level . (required)
    ... author 0..* AuthorParticipation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 0..1 CS Binding: ActStatus (required)
    ... effectiveTime 0..1 IVL_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD Binding: Priority Level . (required)
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author 0..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..* EntryRelationship
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.templateId:priority-pref.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v6.5
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v6.5
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Observation.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-effectiveTime, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:priority-pref 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.143
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 225773000
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 0..1 CS Binding: ActStatus (required)
    ... effectiveTime 0..1 IVL_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD Binding: Priority Level . (required)
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author 0..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..* EntryRelationship
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.templateId:priority-pref.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.classCode Base required CDAActClassObservation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v6.5
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value Base required Priority Level . 📦20240606 VSAC v0.23
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v6.5
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Observation.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-effectiveTime warning Observation SHOULD contain effectiveTime effectiveTime.exists()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Observation

    Summary

    Mandatory: 7 elements
    Fixed: 2 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.templateId

     

    Other representations of profile: CSV, Excel