International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.37--20200508162154 | Version: 1.1.0-ballot | |||
Draft as of 2020-05-08 | Computable Name: IPSAdvanceDirectiveObservation | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.4.37 (use: official, ) |
This clinical statement represents Advance Directive Observation findings (e.g., “resuscitation status is Full Code”) rather than orders. It should not be considered a legal document or a substitute for the actual Advance Directive document. The related legal documents are referenced using the reference/externalReference element. The Advance Directive Observation describes the patient’s directives, including but not limited to: • Medications • Transfer of Care to Hospital • Treatment • Procedures • Intubation and Ventilation • Diagnostic Tests • Tests The observation/value element contains the detailed patient directive which may be coded or text. For example, a category directive may be antibiotics, and the details would be intravenous antibiotics only.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.37 | |
@classCode | 1..1 | code | Fixed Value: OBS | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 (example): AdvanceDirectiveTypeCode |
statusCode | S | 1..1 | CS | |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
low | S | 1..1 | IVXB_TS | |
high | S | 1..1 | IVXB_TS | |
value | S | 1..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 | S | 0..* | Author | |
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
participant:primary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Fixed Value: VRF | |
Slices for time | Content/Rules for all slices | |||
time:primary | S | 1..1 | IVL_TS | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:primary | S | 1..1 | ParticipantRole | |
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | |
Slices for addr | Content/Rules for all slices | |||
addr:primary | S | 1..1 | AD | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:primary | 1..1 | PlayingEntity | ||
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | |
Slices for name | Content/Rules for all slices | |||
name:primary | S | 1..1 | PN | |
participant:secondary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Fixed Value: CST | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:secondary | S | 1..1 | ParticipantRole | |
@classCode | 1..1 | code | Fixed Value: AGNT | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | |
Slices for addr | Content/Rules for all slices | |||
addr:secondary | S | 1..1 | AD | |
Slices for telecom | Content/Rules for all slices | |||
telecom:secondary | S | 1..1 | TEL | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:secondary | S | 1..1 | PlayingEntity | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | |
Slices for name | Content/Rules for all slices | |||
name:secondary | S | 1..1 | PN | |
reference | S | 0..* | Reference | |
@typeCode | 1..1 | code | Fixed Value: REFR | |
externalDocument | S | 1..1 | ExternalDocument | |
id | S | 1..* | II | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.37 | |
@classCode | 1..1 | code | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | code | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 (example): AdvanceDirectiveTypeCode |
statusCode | S | 1..1 | CS | Binding: ActStatus (required) |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
low | S | 1..1 | IVXB_TS | |
high | S | 1..1 | IVXB_TS | |
value | S | 1..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 | S | 0..* | Author | |
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
participant:primary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Binding: CDAParticipationType (required) Fixed Value: VRF | |
Slices for time | Content/Rules for all slices | |||
time:primary | S | 1..1 | IVL_TS | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:primary | S | 1..1 | ParticipantRole | |
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | Binding: CDARoleCode (example) |
Slices for addr | Content/Rules for all slices | |||
addr:primary | S | 1..1 | AD | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:primary | 1..1 | PlayingEntity | ||
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | Binding: CDAEntityCode (example) |
Slices for name | Content/Rules for all slices | |||
name:primary | S | 1..1 | PN | |
participant:secondary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Binding: CDAParticipationType (required) Fixed Value: CST | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:secondary | S | 1..1 | ParticipantRole | |
@classCode | 1..1 | code | Binding: CDARoleClassRoot (required) Fixed Value: AGNT | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | Binding: CDARoleCode (example) |
Slices for addr | Content/Rules for all slices | |||
addr:secondary | S | 1..1 | AD | |
Slices for telecom | Content/Rules for all slices | |||
telecom:secondary | S | 1..1 | TEL | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:secondary | S | 1..1 | PlayingEntity | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | Binding: CDAEntityCode (example) |
Slices for name | Content/Rules for all slices | |||
name:secondary | S | 1..1 | PN | |
reference | S | 0..* | Reference | |
@typeCode | 1..1 | code | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
externalDocument | S | 1..1 | ExternalDocument | |
id | S | 1..* | II | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.participant:primary.typeCode | required | Fixed Value: VRFhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:primary.participantRole:primary.code:primary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.code:primary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.participant:secondary.typeCode | required | Fixed Value: CSThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:secondary.participantRole:secondary.classCode | required | Fixed Value: AGNThttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:secondary.participantRole:secondary.code:secondary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.code:secondary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.participant:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.typeCode | required | Fixed Value: VRFhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:primary.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Observation.participant:primary.participantRole:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:primary.participantRole:primary.code:primary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.code:primary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.participant:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.typeCode | required | Fixed Value: CSThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:secondary.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Observation.participant:secondary.participantRole:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.classCode | required | Fixed Value: AGNThttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:secondary.participantRole:secondary.code:secondary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.code:secondary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference | |
Observation.reference.externalDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.classCode | required | ActClassDocumenthttp://terminology.hl7.org/ValueSet/v3-ActClassDocument | |
Observation.reference.externalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Observation.reference.externalDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
Observation.reference.externalDocument.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.reference.externalDocument.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.reference.externalDocument.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.reference.externalDocument.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
This structure is derived from Observation
Summary
Mandatory: 31 elements(3 nested mandatory elements)
Must-Support: 24 elements
Fixed: 8 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.37 | |
@classCode | 1..1 | code | Fixed Value: OBS | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 (example): AdvanceDirectiveTypeCode |
statusCode | S | 1..1 | CS | |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
low | S | 1..1 | IVXB_TS | |
high | S | 1..1 | IVXB_TS | |
value | S | 1..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 | S | 0..* | Author | |
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
participant:primary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Fixed Value: VRF | |
Slices for time | Content/Rules for all slices | |||
time:primary | S | 1..1 | IVL_TS | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:primary | S | 1..1 | ParticipantRole | |
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | |
Slices for addr | Content/Rules for all slices | |||
addr:primary | S | 1..1 | AD | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:primary | 1..1 | PlayingEntity | ||
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | |
Slices for name | Content/Rules for all slices | |||
name:primary | S | 1..1 | PN | |
participant:secondary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Fixed Value: CST | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:secondary | S | 1..1 | ParticipantRole | |
@classCode | 1..1 | code | Fixed Value: AGNT | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | |
Slices for addr | Content/Rules for all slices | |||
addr:secondary | S | 1..1 | AD | |
Slices for telecom | Content/Rules for all slices | |||
telecom:secondary | S | 1..1 | TEL | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:secondary | S | 1..1 | PlayingEntity | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | |
Slices for name | Content/Rules for all slices | |||
name:secondary | S | 1..1 | PN | |
reference | S | 0..* | Reference | |
@typeCode | 1..1 | code | Fixed Value: REFR | |
externalDocument | S | 1..1 | ExternalDocument | |
id | S | 1..* | II | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | S | 1..1 | II | |
@root | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.37 | |
@classCode | 1..1 | code | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | code | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
id | 0..* | II | ||
code | S | 1..1 | CD | Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 (example): AdvanceDirectiveTypeCode |
statusCode | S | 1..1 | CS | Binding: ActStatus (required) |
@code | 0..1 | cs | Fixed Value: completed | |
effectiveTime | S | 1..1 | IVL_TS | |
low | S | 1..1 | IVXB_TS | |
high | S | 1..1 | IVXB_TS | |
value | S | 1..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 | S | 0..* | Author | |
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
participant:primary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Binding: CDAParticipationType (required) Fixed Value: VRF | |
Slices for time | Content/Rules for all slices | |||
time:primary | S | 1..1 | IVL_TS | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:primary | S | 1..1 | ParticipantRole | |
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | Binding: CDARoleCode (example) |
Slices for addr | Content/Rules for all slices | |||
addr:primary | S | 1..1 | AD | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:primary | 1..1 | PlayingEntity | ||
Slices for code | Content/Rules for all slices | |||
code:primary | S | 1..1 | CE | Binding: CDAEntityCode (example) |
Slices for name | Content/Rules for all slices | |||
name:primary | S | 1..1 | PN | |
participant:secondary | 1..1 | Participant2 | ||
@typeCode | 1..1 | code | Binding: CDAParticipationType (required) Fixed Value: CST | |
Slices for participantRole | Content/Rules for all slices | |||
participantRole:secondary | S | 1..1 | ParticipantRole | |
@classCode | 1..1 | code | Binding: CDARoleClassRoot (required) Fixed Value: AGNT | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | Binding: CDARoleCode (example) |
Slices for addr | Content/Rules for all slices | |||
addr:secondary | S | 1..1 | AD | |
Slices for telecom | Content/Rules for all slices | |||
telecom:secondary | S | 1..1 | TEL | |
Slices for playingEntity | Content/Rules for all slices | |||
playingEntity:secondary | S | 1..1 | PlayingEntity | |
Slices for code | Content/Rules for all slices | |||
code:secondary | S | 1..1 | CE | Binding: CDAEntityCode (example) |
Slices for name | Content/Rules for all slices | |||
name:secondary | S | 1..1 | PN | |
reference | S | 0..* | Reference | |
@typeCode | 1..1 | code | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
externalDocument | S | 1..1 | ExternalDocument | |
id | S | 1..* | II | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.participant:primary.typeCode | required | Fixed Value: VRFhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:primary.participantRole:primary.code:primary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.code:primary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.participant:secondary.typeCode | required | Fixed Value: CSThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:secondary.participantRole:secondary.classCode | required | Fixed Value: AGNThttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:secondary.participantRole:secondary.code:secondary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.code:secondary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.1.11.20.2--20160623000000 | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.participant:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.typeCode | required | Fixed Value: VRFhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:primary.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Observation.participant:primary.participantRole:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:primary.participantRole:primary.code:primary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Observation.participant:primary.participantRole:primary.playingEntity:primary.code:primary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.participant:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.typeCode | required | Fixed Value: CSThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Observation.participant:secondary.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Observation.participant:secondary.participantRole:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.classCode | required | Fixed Value: AGNThttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
Observation.participant:secondary.participantRole:secondary.code:secondary | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Observation.participant:secondary.participantRole:secondary.playingEntity:secondary.code:secondary | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode | |
Observation.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference | |
Observation.reference.externalDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.classCode | required | ActClassDocumenthttp://terminology.hl7.org/ValueSet/v3-ActClassDocument | |
Observation.reference.externalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Observation.reference.externalDocument.code | example | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
Observation.reference.externalDocument.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.reference.externalDocument.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.reference.externalDocument.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.reference.externalDocument.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.reference.externalDocument.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
This structure is derived from Observation
Summary
Mandatory: 31 elements(3 nested mandatory elements)
Must-Support: 24 elements
Fixed: 8 elements
Slices
This structure defines the following Slices: