Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CaregiverCharacteristics | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: CaregiverCharacteristics | |||
| Other Identifiers: 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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation |
C | 1..1 | Observation | XML 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 Instance 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..* | II | Slice: Unordered, Open by value:root | |
   templateId:caregiver-characteristics |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.72 | |
  @extension |
0..0 | |||
 @classCode |
1..1 | cs | Fixed Value: OBS | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | This 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..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
 value |
C | 1..1 | CD | 81-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..1 | cs | Fixed Value: IND | |
| time |
0..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Fixed Value: CAREGIVER | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 1..1 | Observation | XML 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 Instance 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..* | II | Slice: Unordered, Open by value:root | |
| templateId:caregiver-characteristics |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.72 | |
| @classCode |
1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
| @moodCode |
1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | This 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..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| value |
C | 1..1 | CD | 81-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..1 | cs | Binding: CDAParticipationType (required) Fixed Value: IND | |
| time |
0..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: CAREGIVER | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.participant.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Observation.participant.participantRole.classCode | required | Fixed Value: CAREGIVERhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot |
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 1..1 | Observation | XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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:caregiver-characteristics |
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.72 | |
| @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 | ||
| code |
1..1 | CD | This 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..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 | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @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) | |
| 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 |
C | 1..1 | CD | 81-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..* | 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..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
1..* | Participant2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: IND | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
1..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: CAREGIVER | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| referenceRange |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.templateId:caregiver-characteristics.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
| Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
| Observation.participant.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Observation.participant.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Observation.participant.time.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.time.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Observation.participant.participantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.participantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.participantRole.classCode | required | Fixed Value: CAREGIVERhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| Observation.participant.participantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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: 9 elements(1 nested mandatory element)
Fixed: 5 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 1..1 | Observation | XML 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 Instance 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..* | II | Slice: Unordered, Open by value:root | |
| templateId:caregiver-characteristics |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.72 | |
| @extension |
0..0 | |||
| @classCode |
1..1 | cs | Fixed Value: OBS | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | This 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..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| value |
C | 1..1 | CD | 81-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..1 | cs | Fixed Value: IND | |
| time |
0..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Fixed Value: CAREGIVER | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 1..1 | Observation | XML 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 Instance 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..* | II | Slice: Unordered, Open by value:root | |
| templateId:caregiver-characteristics |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.72 | |
| @classCode |
1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
| @moodCode |
1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | This 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..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| value |
C | 1..1 | CD | 81-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..1 | cs | Binding: CDAParticipationType (required) Fixed Value: IND | |
| time |
0..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: CAREGIVER | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.participant.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Observation.participant.participantRole.classCode | required | Fixed Value: CAREGIVERhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot |
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 1..1 | Observation | XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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:caregiver-characteristics |
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.72 | |
| @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 | ||
| code |
1..1 | CD | This 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..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 | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @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) | |
| 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 |
C | 1..1 | CD | 81-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..* | 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..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
1..* | Participant2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: IND | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
1..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: CAREGIVER | |
| id |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| referenceRange |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.templateId:caregiver-characteristics.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
| Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
| Observation.participant.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Observation.participant.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Observation.participant.time.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.time.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Observation.participant.participantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.participantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.participant.participantRole.classCode | required | Fixed Value: CAREGIVERhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| Observation.participant.participantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
| Id | Grade | Path(s) | Details | Requirements |
| 81-14600 | error | Observation.value | 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). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| 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: 9 elements(1 nested mandatory element)
Fixed: 5 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change