Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
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
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/OutcomeObservation | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: OutcomeObservation | |||
| Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.144 | ||||
This template represents the outcome of care resulting from the interventions used to treat the patient. In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
Often thought of as an “actual outcome”, the Outcome Observation may be related to goals, progression toward goals, and the associated interventions. For example, an observation outcome of a blood oxygen saturation level of 95% is related to the goal of “Maintain Pulse Ox greater than 92”, which in turn is related to the health concern of respiratory insufficiency and the problem of pneumonia. The template makes use of the Entry Reference (templateId:2.16.840.1.113883.10.20.22.4.122) to reference the interventions and goals defined elsewhere in the Care Plan CDA instance.
Usage:
Description of Profiles, 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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value should-author: SHOULD contain author |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
   templateId:outcome-obs | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.144 | |
  @extension | 0..0 | |||
 @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| 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 |
| value | 0..1 | ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | ||
 author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
 entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
 @typeCode | 1..1 | cs | Fixed Value: GEVL | |
| act | 1..1 | EntryReference | Base for all types and resources | |
| entryRelationship:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @typeCode | 1..1 | cs | Fixed Value: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | ProgressTowardGoalObservation | Base for all types and resources | |
| entryRelationship:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Fixed Value: RSON | |
| act | 1..1 | EntryReference | Base for all types and resources | |
 reference | 0..* | Reference | ||
| @typeCode | 1..1 | cs | Fixed Value: REFR | |
| externalDocument | 1..1 | ExternalDocumentReference | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : 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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:outcome-obs | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.144 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 1..1 | CD | 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 |
 value | 0..1 | |||
 value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
| entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: GEVL | |
| act | C | 1..1 | EntryReference | Base for all types and resources |
| entryRelationship:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | C | 1..1 | ProgressTowardGoalObservation | Base for all types and resources |
| entryRelationship:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| act | C | 1..1 | EntryReference | Base for all types and resources |
| reference | 0..* | Reference | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
| externalDocument | C | 1..1 | ExternalDocumentReference | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: EVN |
| Observation.code | example | ObservationType |
| Observation.entryRelationship:goal-reference.typeCode | required | Fixed Value: GEVL |
| Observation.entryRelationship:progressTowardGoalObservation.typeCode | required | Fixed Value: SPRT |
| Observation.entryRelationship:intervention-reference.typeCode | required | Fixed Value: RSON |
| Observation.reference.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-setId | warning | Observation.reference.externalDocument | SHOULD contain setId : setId.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:goal-reference.act, Observation.entryRelationship:progressTowardGoalObservation.observation, Observation.entryRelationship:intervention-reference.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : value.exists() | |
| should-versionNumber | warning | Observation.reference.externalDocument | SHOULD contain versionNumber : versionNumber.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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value 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 | |
| templateId:outcome-obs | 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.144 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (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 | 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: CompressionAlgorithm (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: Binary Data Encoding Value Set (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 | 0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime | 0..1 | IVL_TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber | 0..1 | IVL_INT | ||
| languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
| value | 0..1 | |||
| value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
| methodCode | 0..* | CE | Binding: ObservationMethod (example) | |
| targetSiteCode | 0..* | CD | ||
| subject | 0..1 | Subject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| informant | 0..* | Informant | ||
| participant | 0..* | Participant2 | ||
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
| entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @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: GEVL | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | C | 1..1 | EntryReference | Base for all types and resources |
| encounter | 0..1 | Encounter | ||
| observation | 0..1 | Observation | ||
| 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:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @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: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| @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 | ProgressTowardGoalObservation | Base for all types and resources |
| 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:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @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 | C | 1..1 | EntryReference | Base for all types and resources |
| encounter | 0..1 | Encounter | ||
| observation | 0..1 | Observation | ||
| 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 | ||
| @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_ActRelationshipExternalReference (required) Fixed Value: REFR | |
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | C | 1..1 | ExternalDocumentReference | Base for all types and resources |
| 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: ActRelationshipType (2.0.0) (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 |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:outcome-obs.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: EVN |
| Observation.code | example | ObservationType |
| Observation.text.nullFlavor | required | CDANullFlavor |
| Observation.text.compression | required | CDACompressionAlgorithm |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Observation.text.mediaType | example | MediaType |
| Observation.text.representation | required | BinaryDataEncoding |
| Observation.statusCode | required | ActStatus |
| Observation.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| Observation.entryRelationship:goal-reference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:goal-reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:goal-reference.typeCode | required | Fixed Value: GEVL |
| Observation.entryRelationship:progressTowardGoalObservation.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:progressTowardGoalObservation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:progressTowardGoalObservation.typeCode | required | Fixed Value: SPRT |
| Observation.entryRelationship:intervention-reference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:intervention-reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:intervention-reference.typeCode | required | Fixed Value: RSON |
| Observation.reference.nullFlavor | required | CDANullFlavor |
| Observation.reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.reference.typeCode | required | Fixed Value: REFR |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-setId | warning | Observation.reference.externalDocument | SHOULD contain setId : setId.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:goal-reference.act, Observation.entryRelationship:progressTowardGoalObservation.observation, Observation.entryRelationship:intervention-reference.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : value.exists() | |
| should-versionNumber | warning | Observation.reference.externalDocument | SHOULD contain versionNumber : versionNumber.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: 5 elements (5 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:outcome-obs | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.144 | |
| @extension | 0..0 | |||
| @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| 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 |
| value | 0..1 | ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | ||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
| entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Fixed Value: GEVL | |
| act | 1..1 | EntryReference | Base for all types and resources | |
| entryRelationship:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @typeCode | 1..1 | cs | Fixed Value: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | ProgressTowardGoalObservation | Base for all types and resources | |
| entryRelationship:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Fixed Value: RSON | |
| act | 1..1 | EntryReference | Base for all types and resources | |
| reference | 0..* | Reference | ||
| @typeCode | 1..1 | cs | Fixed Value: REFR | |
| externalDocument | 1..1 | ExternalDocumentReference | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : 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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:outcome-obs | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.144 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 1..1 | CD | 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 |
| value | 0..1 | |||
| value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
| entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: GEVL | |
| act | C | 1..1 | EntryReference | Base for all types and resources |
| entryRelationship:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | C | 1..1 | ProgressTowardGoalObservation | Base for all types and resources |
| entryRelationship:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| act | C | 1..1 | EntryReference | Base for all types and resources |
| reference | 0..* | Reference | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
| externalDocument | C | 1..1 | ExternalDocumentReference | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: EVN |
| Observation.code | example | ObservationType |
| Observation.entryRelationship:goal-reference.typeCode | required | Fixed Value: GEVL |
| Observation.entryRelationship:progressTowardGoalObservation.typeCode | required | Fixed Value: SPRT |
| Observation.entryRelationship:intervention-reference.typeCode | required | Fixed Value: RSON |
| Observation.reference.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-setId | warning | Observation.reference.externalDocument | SHOULD contain setId : setId.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:goal-reference.act, Observation.entryRelationship:progressTowardGoalObservation.observation, Observation.entryRelationship:intervention-reference.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : value.exists() | |
| should-versionNumber | warning | Observation.reference.externalDocument | SHOULD contain versionNumber : versionNumber.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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-value: SHOULD contain value 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 | |
| templateId:outcome-obs | 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.144 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (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 | 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: CompressionAlgorithm (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: Binary Data Encoding Value Set (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 | 0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime | 0..1 | IVL_TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (example) | |
| repeatNumber | 0..1 | IVL_INT | ||
| languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
| value | 0..1 | |||
| value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
| methodCode | 0..* | CE | Binding: ObservationMethod (example) | |
| targetSiteCode | 0..* | CD | ||
| subject | 0..1 | Subject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| informant | 0..* | Informant | ||
| participant | 0..* | Participant2 | ||
| Slices for entryRelationship | 1..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry. Slice: Unordered, Open by value:typeCode, profile:act, profile:observation | |
| entryRelationship:goal-reference | C | 0..* | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @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: GEVL | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | C | 1..1 | EntryReference | Base for all types and resources |
| encounter | 0..1 | Encounter | ||
| observation | 0..1 | Observation | ||
| 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:progressTowardGoalObservation | 0..1 | EntryRelationship | The following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. | |
| @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: SPRT | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| @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 | ProgressTowardGoalObservation | Base for all types and resources |
| 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:intervention-reference | C | 0..* | EntryRelationship | Where an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry entry-ref-intervention: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
| @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 | C | 1..1 | EntryReference | Base for all types and resources |
| encounter | 0..1 | Encounter | ||
| observation | 0..1 | Observation | ||
| 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 | ||
| @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_ActRelationshipExternalReference (required) Fixed Value: REFR | |
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | C | 1..1 | ExternalDocumentReference | Base for all types and resources |
| 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: ActRelationshipType (2.0.0) (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 |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:outcome-obs.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: EVN |
| Observation.code | example | ObservationType |
| Observation.text.nullFlavor | required | CDANullFlavor |
| Observation.text.compression | required | CDACompressionAlgorithm |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Observation.text.mediaType | example | MediaType |
| Observation.text.representation | required | BinaryDataEncoding |
| Observation.statusCode | required | ActStatus |
| Observation.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| Observation.entryRelationship:goal-reference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:goal-reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:goal-reference.typeCode | required | Fixed Value: GEVL |
| Observation.entryRelationship:progressTowardGoalObservation.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:progressTowardGoalObservation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:progressTowardGoalObservation.typeCode | required | Fixed Value: SPRT |
| Observation.entryRelationship:intervention-reference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:intervention-reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:intervention-reference.typeCode | required | Fixed Value: RSON |
| Observation.reference.nullFlavor | required | CDANullFlavor |
| Observation.reference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.reference.typeCode | required | Fixed Value: REFR |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| entry-ref-goal | error | Observation.entryRelationship:goal-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| entry-ref-intervention | error | Observation.entryRelationship:intervention-reference | This entryReference template **SHALL** reference an instance of a Goal Observation template. : %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.131' and $this.extension = '2015-08-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)) | |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-setId | warning | Observation.reference.externalDocument | SHOULD contain setId : setId.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:goal-reference.act, Observation.entryRelationship:progressTowardGoalObservation.observation, Observation.entryRelationship:intervention-reference.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-value | warning | Observation | SHOULD contain value : value.exists() | |
| should-versionNumber | warning | Observation.reference.externalDocument | SHOULD contain versionNumber : versionNumber.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: 5 elements (5 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element
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-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change