Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Caregiver Characteristics

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CaregiverCharacteristics Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: CaregiverCharacteristics
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.72

This clinical statement represents a caregiver’s willingness to provide care and the abilities of that caregiver to provide assistance to a patient in relation to a specific need.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
..... @extension 0..0
... @classCode 1..1csFixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: completed
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... participant 1..*Participant2
.... @typeCode 1..1csFixed Value: IND
.... time 0..1IVL_TS
..... low 1..1IVXB_TS
..... high 0..1IVXB_TS
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csFixed Value: CAREGIVER

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
Binding: ObservationType (example)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... participant 1..*Participant2
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
.... time 0..1IVL_TS
..... low 1..1IVXB_TS
..... high 0..1IVXB_TS
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: CAREGIVER

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.participant.typeCoderequiredFixed Value: IND
Observation.participant.participantRole.classCoderequiredFixed Value: CAREGIVER

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
Binding: ObservationType (example)
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (example)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 1..*Participant2
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
..... @operator 0..1csBinding: SetOperator (required)
..... low 1..1IVXB_TS
..... center 0..1TS
..... width 0..1PQ
..... high 0..1IVXB_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: CAREGIVER
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (example)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:caregiver-characteristics.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.participant.nullFlavorrequiredCDANullFlavor
Observation.participant.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant.typeCoderequiredFixed Value: IND
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.time.nullFlavorrequiredCDANullFlavor
Observation.participant.time.operatorrequiredSetOperator
Observation.participant.participantRole.nullFlavorrequiredCDANullFlavor
Observation.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant.participantRole.classCoderequiredFixed Value: CAREGIVER
Observation.participant.participantRole.codeexampleRoleCode
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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: 8 elements (1 nested mandatory element)
Fixed Value: 5 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
..... @extension 0..0
... @classCode 1..1csFixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: completed
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... participant 1..*Participant2
.... @typeCode 1..1csFixed Value: IND
.... time 0..1IVL_TS
..... low 1..1IVXB_TS
..... high 0..1IVXB_TS
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csFixed Value: CAREGIVER

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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 & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
Binding: ObservationType (example)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... participant 1..*Participant2
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
.... time 0..1IVL_TS
..... low 1..1IVXB_TS
..... high 0..1IVXB_TS
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: CAREGIVER

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.participant.typeCoderequiredFixed Value: IND
Observation.participant.participantRole.classCoderequiredFixed Value: CAREGIVER

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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 & Constraintsdoco
.. Observation C1..1ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:caregiver-characteristics 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.72
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
Binding: ObservationType (example)
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value C1..1CD81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (example)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 1..*Participant2
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
..... @operator 0..1csBinding: SetOperator (required)
..... low 1..1IVXB_TS
..... center 0..1TS
..... width 0..1PQ
..... high 0..1IVXB_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: CAREGIVER
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (example)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:caregiver-characteristics.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.participant.nullFlavorrequiredCDANullFlavor
Observation.participant.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant.typeCoderequiredFixed Value: IND
Observation.participant.contextControlCoderequiredFixed Value: OP
Observation.participant.time.nullFlavorrequiredCDANullFlavor
Observation.participant.time.operatorrequiredSetOperator
Observation.participant.participantRole.nullFlavorrequiredCDANullFlavor
Observation.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant.participantRole.classCoderequiredFixed Value: CAREGIVER
Observation.participant.participantRole.codeexampleRoleCode
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
81-14600errorObservation.valueThe code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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: 8 elements (1 nested mandatory element)
Fixed Value: 5 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel