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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedEncounter | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: PlannedEncounter | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09 | ||||
This template represents a planned or ordered encounter. The type of encounter (e.g., comprehensive outpatient visit) is represented. Clinicians participating in the encounter and the location of the planned encounter may be captured. The priority that the patient and providers place on the encounter may be represented.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:planned-enc |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
  @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
 @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure)  (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| effectiveTime |
0..1 | IVL_TS | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
 author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | ||
| @typeCode |
1..1 | cs | Fixed Value: LOC | |
| participantRole |
1..1 | ServiceDeliveryLocation | Base for all types and resources | |
 Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
 entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
 @typeCode |
1..1 | cs | Fixed Value: REFR | |
| observation |
1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Fixed Value: RSON | |
| observation |
1..1 | Indication | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 |
|---|---|---|---|---|
| Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-enc |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| effectiveTime |
0..1 | IVL_TS | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LOC | |
| participantRole |
C | 1..1 | ServiceDeliveryLocation | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom |
| Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
| entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Encounter.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Encounter.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Encounter.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| role-choice | error | Encounter.participant:location.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| should-addr | warning | Encounter.participant:location.participantRole | SHOULD contain addr : addr.exists() | |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-author | warning | Encounter.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-telecom | warning | Encounter.participant:location.participantRole | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 |
|---|---|---|---|---|
| Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| @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, value:extension | |
| templateId:planned-enc |
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.40 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| @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 | ||
| sdtcDischargeDispositionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: dischargeDispositionCode (urn:hl7-org:sdtc) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| @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: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| modeCode |
0..1 | CE | ||
| assignedEntity |
1..1 | AssignedEntity | ||
| author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| informant |
0..* | Informant | ||
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | 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: LOC | |
| @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 | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ServiceDeliveryLocation | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom |
| Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
| entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
| @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: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @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: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.templateId:planned-enc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 | |
| Encounter.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Encounter.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Encounter.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Encounter.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Encounter.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Encounter.participant:location.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.participant:location.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Encounter.participant:location.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Encounter.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Encounter.entryRelationship:indication.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Encounter.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| role-choice | error | Encounter.participant:location.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| should-addr | warning | Encounter.participant:location.participantRole | SHOULD contain addr : addr.exists() | |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-author | warning | Encounter.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-telecom | warning | Encounter.participant:location.participantRole | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 Encounter
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-enc |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| effectiveTime |
0..1 | IVL_TS | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | ||
| @typeCode |
1..1 | cs | Fixed Value: LOC | |
| participantRole |
1..1 | ServiceDeliveryLocation | Base for all types and resources | |
| Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
| entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| observation |
1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Fixed Value: RSON | |
| observation |
1..1 | Indication | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 |
|---|---|---|---|---|
| Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-enc |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.40 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| effectiveTime |
0..1 | IVL_TS | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| assignedEntity |
1..1 | AssignedEntity | ||
| author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LOC | |
| participantRole |
C | 1..1 | ServiceDeliveryLocation | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom |
| Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
| entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Encounter.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Encounter.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Encounter.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| role-choice | error | Encounter.participant:location.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| should-addr | warning | Encounter.participant:location.participantRole | SHOULD contain addr : addr.exists() | |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-author | warning | Encounter.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-telecom | warning | Encounter.participant:location.participantRole | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 |
|---|---|---|---|---|
| Encounter |
C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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 should-code: SHOULD contain code should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| @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, value:extension | |
| templateId:planned-enc |
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.40 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Records the type of encounter ordered or recommended. Binding: Encounter Planned (preferred) | |
| 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: active | |
| @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 | ||
| sdtcDischargeDispositionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: dischargeDispositionCode (urn:hl7-org:sdtc) | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | Performers represent clinicians who are responsible for assessing and treating the patient. | |
| @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: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| modeCode |
0..1 | CE | ||
| assignedEntity |
1..1 | AssignedEntity | ||
| author |
0..* | AuthorParticipation | The author in a planned encounter represents the clinician who is requesting or planning the encounter. | |
| informant |
0..* | Informant | ||
| Slices for participant |
0..* | Participant2 | This location participation captures where the planned or ordered encounter may take place. Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | 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: LOC | |
| @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 | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ServiceDeliveryLocation | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom |
| Slices for entryRelationship |
0..* | EntryRelationship | The following entryRelationship captures the reason for the planned or ordered encounter Slice: Unordered, Open by profile:observation | |
| entryRelationship:priorityPreference |
0..1 | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the encounter. | |
| @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: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| entryRelationship:indication |
0..* | EntryRelationship | ||
| @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: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.templateId:planned-enc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Encounter.moodCode | required | PlannedMoodCodeActEncounterProcedure http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23 | |
| Encounter.code | preferred | EncounterPlanned http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.52 | |
| Encounter.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Encounter.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Encounter.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Encounter.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Encounter.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Encounter.participant:location.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.participant:location.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Encounter.participant:location.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Encounter.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Encounter.entryRelationship:indication.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Encounter.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Encounter.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| role-choice | error | Encounter.participant:location.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| should-addr | warning | Encounter.participant:location.participantRole | SHOULD contain addr : addr.exists() | |
| should-author | warning | Encounter | SHOULD contain author : author.exists() | |
| should-author | warning | Encounter.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-code | warning | Encounter | SHOULD contain code : code.exists() | |
| should-effectiveTime | warning | Encounter | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-telecom | warning | Encounter.participant:location.participantRole | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Encounter | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Encounter.entryRelationship:priorityPreference.observation, Encounter.entryRelationship:indication.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Encounter.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 Encounter
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
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