Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation | Version: 2.1 | |||
Draft as of 2023-09-29 | Computable Name: AdvanceDirectiveObservation | |||
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2015-08-01 |
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:
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 Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
classCode | 1..1 | cs | Fixed Value: OBS | |
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.48 | |
extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
code | 1..1 | cs | Required Pattern: 75320-2 | |
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB | |
code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | ||
low | 1..1 | IVXB_TS | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
value | C | 1..1 | ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
extension | 0..0 | |||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
typeCode | 1..1 | cs | Fixed Value: VRF | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
participantRole | 1..1 | ParticipantRole | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
participant:participant2 | 0..* | Participant2 | ||
typeCode | 1..1 | cs | Fixed Value: CST | |
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | cs | Fixed Value: AGNT | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
playingEntity | 1..1 | PlayingEntity | ||
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
typeCode | 1..1 | cs | Fixed Value: REFR | |
externalDocument | 1..1 | ExternalDocument | ||
id | 1..* | II | ||
text | 0..1 | ED | ||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | preferred | Advance Directive Type Code |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
@classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.48 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
@code | 1..1 | cs | Required Pattern: 75320-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | ||
low | 1..1 | IVXB_TS | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
value | C | 1..1 | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
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 participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
participantRole | 1..1 | ParticipantRole | ||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: VRF | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | C | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
participant:participant2 | 0..* | Participant2 | ||
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: CST | |
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: AGNT | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingEntity | 1..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
externalDocument | 1..1 | ExternalDocument | ||
@classCode | 1..1 | cs | Binding: ActClassDocument (required) | |
id | 1..* | II | ||
text | 0..1 | ED | ||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.code | preferred | Advance Directive Type Code |
Observation.statusCode | required | ActStatus |
Observation.participant:participant1.typeCode | required | Fixed Value: VRF |
Observation.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.typeCode | required | Fixed Value: CST |
Observation.participant:participant2.participantRole.classCode | required | Fixed Value: AGNT |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Observation.reference:reference1.typeCode | required | Fixed Value: REFR |
Observation.reference:reference1.externalDocument.classCode | required | ActClassDocument |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : | |
81-7296 | error | Observation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
81-9371 | error | Observation.participant:participant1.participantRole.playingEntity.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
81-9372 | error | Observation.participant:participant1.participantRole.playingEntity.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
pn-no-ls | error | Observation.participant:participant1.participantRole.playingEntity.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
@classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
@negationInd | 0..1 | bl | ||
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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.48 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: 75320-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
derivationExpr | 0..1 | ST | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
@operator | 0..1 | cs | Binding: SetOperator (required) | |
low | 1..1 | IVXB_TS | ||
center | 0..1 | TS | ||
width | 0..1 | PQ | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
repeatNumber | 0..1 | IVL_INT | ||
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
value | C | 1..1 | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
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 (extensible) | |
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 | ||
Slices for participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 0..1 | cs | Binding: ParticipationType (required) | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: VRF | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: EntityCode (extensible) | |
quantity | 0..* | PQ | ||
name | C | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
participant:participant2 | 0..* | Participant2 | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: CST | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: AGNT | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 1..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
quantity | 0..* | PQ | ||
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
entryRelationship | 0..* | EntryRelationship | ||
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
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 | 1..1 | ExternalDocument | ||
@classCode | 1..1 | cs | Binding: ActClassDocument (required) | |
@moodCode | 0..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
templateId | 0..* | II | ||
id | 1..* | II | ||
code | 0..1 | CD | Binding: FHIRDocumentTypeCodes (extensible) | |
text | 0..1 | ED | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@charset | 0..1 | cs | ||
@compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
@integrityCheck | 0..1 | bin | ||
@integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (required) | |
@language | 0..1 | cs | ||
@mediaType | 0..1 | cs | ||
@representation | 0..1 | cs | ||
data[x] | 0..1 | |||
dataString | string(st) | |||
dataBase64Binary | base64Binary(bin) | |||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
thumbnail | 0..1 | ED | ||
setId | 0..1 | II | ||
versionNumber | 0..1 | INT | ||
precondition | 0..* | Precondition | ||
referenceRange | 0..* | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 0..1 | cs | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
observationRange | 1..1 | ObservationRange | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.code | preferred | Advance Directive Type Code |
Observation.code.nullFlavor | required | NullFlavor |
Observation.code.translation:advanceDirective.nullFlavor | required | NullFlavor |
Observation.statusCode | required | ActStatus |
Observation.statusCode.nullFlavor | required | NullFlavor |
Observation.effectiveTime.nullFlavor | required | NullFlavor |
Observation.effectiveTime.operator | required | SetOperator |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.participant.nullFlavor | required | NullFlavor |
Observation.participant.typeCode | required | ParticipationType |
Observation.participant.contextControlCode | required | Fixed Value: OP |
Observation.participant.templateId:primary.nullFlavor | required | NullFlavor |
Observation.participant:participant1.nullFlavor | required | NullFlavor |
Observation.participant:participant1.typeCode | required | Fixed Value: VRF |
Observation.participant:participant1.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Observation.participant:participant1.participantRole.playingEntity.code | extensible | EntityCode |
Observation.participant:participant2.nullFlavor | required | NullFlavor |
Observation.participant:participant2.typeCode | required | Fixed Value: CST |
Observation.participant:participant2.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant2.participantRole.classCode | required | Fixed Value: AGNT |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Observation.reference:reference1.nullFlavor | required | NullFlavor |
Observation.reference:reference1.typeCode | required | Fixed Value: REFR |
Observation.reference:reference1.externalDocument.classCode | required | ActClassDocument |
Observation.reference:reference1.externalDocument.moodCode | required | Fixed Value: EVN |
Observation.reference:reference1.externalDocument.code | extensible | FHIRDocumentTypeCodes |
Observation.reference:reference1.externalDocument.text.nullFlavor | required | NullFlavor |
Observation.reference:reference1.externalDocument.text.compression | required | CompressionAlgorithm |
Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.referenceRange.nullFlavor | required | NullFlavor |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : | |
81-7296 | error | Observation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
81-9371 | error | Observation.participant:participant1.participantRole.playingEntity.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
81-9372 | error | Observation.participant:participant1.participantRole.playingEntity.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
pn-no-ls | error | Observation.participant:participant1.participantRole.playingEntity.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 19 elements (7 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 CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
classCode | 1..1 | cs | Fixed Value: OBS | |
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.48 | |
extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
code | 1..1 | cs | Required Pattern: 75320-2 | |
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB | |
code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | ||
low | 1..1 | IVXB_TS | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
value | C | 1..1 | ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
extension | 0..0 | |||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
typeCode | 1..1 | cs | Fixed Value: VRF | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
participantRole | 1..1 | ParticipantRole | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
participant:participant2 | 0..* | Participant2 | ||
typeCode | 1..1 | cs | Fixed Value: CST | |
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | cs | Fixed Value: AGNT | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
playingEntity | 1..1 | PlayingEntity | ||
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
typeCode | 1..1 | cs | Fixed Value: REFR | |
externalDocument | 1..1 | ExternalDocument | ||
id | 1..* | II | ||
text | 0..1 | ED | ||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | preferred | Advance Directive Type Code |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
@classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.48 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
@code | 1..1 | cs | Required Pattern: 75320-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | ||
low | 1..1 | IVXB_TS | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
value | C | 1..1 | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
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 participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
participantRole | 1..1 | ParticipantRole | ||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: VRF | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | C | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
participant:participant2 | 0..* | Participant2 | ||
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: CST | |
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: AGNT | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingEntity | 1..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) Fixed Value: REFR | |
externalDocument | 1..1 | ExternalDocument | ||
@classCode | 1..1 | cs | Binding: ActClassDocument (required) | |
id | 1..* | II | ||
text | 0..1 | ED | ||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.code | preferred | Advance Directive Type Code |
Observation.statusCode | required | ActStatus |
Observation.participant:participant1.typeCode | required | Fixed Value: VRF |
Observation.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.typeCode | required | Fixed Value: CST |
Observation.participant:participant2.participantRole.classCode | required | Fixed Value: AGNT |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Observation.reference:reference1.typeCode | required | Fixed Value: REFR |
Observation.reference:reference1.externalDocument.classCode | required | ActClassDocument |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : | |
81-7296 | error | Observation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
81-9371 | error | Observation.participant:participant1.participantRole.playingEntity.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
81-9372 | error | Observation.participant:participant1.participantRole.playingEntity.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
pn-no-ls | error | Observation.participant:participant1.participantRole.playingEntity.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
@classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
@negationInd | 0..1 | bl | ||
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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.48 | |
@extension | 1..1 | st | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: Advance Directive Type Code (preferred) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code, value:codeSystem | |
translation:advanceDirective | 1..1 | CD | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: 75320-2 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
derivationExpr | 0..1 | ST | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | SG 20230706: constraint not entered 'properly' deleted fixedCode='Completed here - it's already in the next element and shoudln't be here - entered weird/wrong in TWB Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
@operator | 0..1 | cs | Binding: SetOperator (required) | |
low | 1..1 | IVXB_TS | ||
center | 0..1 | TS | ||
width | 0..1 | PQ | ||
high | C | 1..1 | IVXB_TS | 1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
repeatNumber | 0..1 | IVL_INT | ||
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
value | C | 1..1 | 1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). | |
value | ANY | |||
value | BL | |||
value | ED | |||
value | ST | |||
value | CD | |||
value | CV | |||
value | CE | |||
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 (extensible) | |
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 | ||
Slices for participant | 0..* | Participant2 | This custodian (CST) participant identifies a legal representative for the patient's advance directive. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. If there is more than one legal representative, a qualifier may be used to designate the legal representative as primary or secondary. Slice: Unordered, Open by value:participantRole, value:typeCode | |
participant:All Slices | Content/Rules for all slices | |||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 0..1 | cs | Binding: ParticipationType (required) | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.58 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
participant:participant1 | 0..* | Participant2 | The participant "VRF" represents the clinician(s) who verified the patient advance directive observation. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: VRF | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | C | 0..1 | IVL_TS | 1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). |
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: EntityCode (extensible) | |
quantity | 0..* | PQ | ||
name | C | 0..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
participant:participant2 | 0..* | Participant2 | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: CST | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: AGNT | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Personal And Legal Relationship Role Type (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 1..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: Healthcare Agent Qualifier (preferred) | |
quantity | 0..* | PQ | ||
name | 1..1 | PN | Record the name of the agent who can provide a copy of the Advance Directive in the name element. | |
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
entryRelationship | 0..* | EntryRelationship | ||
Slices for reference | 1..* | Reference | Slice: Unordered, Open by value:externalDocument, value:typeCode | |
reference:reference1 | 1..* | Reference | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
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 | 1..1 | ExternalDocument | ||
@classCode | 1..1 | cs | Binding: ActClassDocument (required) | |
@moodCode | 0..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
templateId | 0..* | II | ||
id | 1..* | II | ||
code | 0..1 | CD | Binding: FHIRDocumentTypeCodes (extensible) | |
text | 0..1 | ED | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@charset | 0..1 | cs | ||
@compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
@integrityCheck | 0..1 | bin | ||
@integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (required) | |
@language | 0..1 | cs | ||
@mediaType | 0..1 | cs | ||
@representation | 0..1 | cs | ||
data[x] | 0..1 | |||
dataString | string(st) | |||
dataBase64Binary | base64Binary(bin) | |||
reference | C | 0..1 | TEL | 1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). 1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). |
thumbnail | 0..1 | ED | ||
setId | 0..1 | II | ||
versionNumber | 0..1 | INT | ||
precondition | 0..* | Precondition | ||
referenceRange | 0..* | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 0..1 | cs | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
observationRange | 1..1 | ObservationRange | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.code | preferred | Advance Directive Type Code |
Observation.code.nullFlavor | required | NullFlavor |
Observation.code.translation:advanceDirective.nullFlavor | required | NullFlavor |
Observation.statusCode | required | ActStatus |
Observation.statusCode.nullFlavor | required | NullFlavor |
Observation.effectiveTime.nullFlavor | required | NullFlavor |
Observation.effectiveTime.operator | required | SetOperator |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.participant.nullFlavor | required | NullFlavor |
Observation.participant.typeCode | required | ParticipationType |
Observation.participant.contextControlCode | required | Fixed Value: OP |
Observation.participant.templateId:primary.nullFlavor | required | NullFlavor |
Observation.participant:participant1.nullFlavor | required | NullFlavor |
Observation.participant:participant1.typeCode | required | Fixed Value: VRF |
Observation.participant:participant1.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Observation.participant:participant1.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Observation.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Observation.participant:participant1.participantRole.playingEntity.code | extensible | EntityCode |
Observation.participant:participant2.nullFlavor | required | NullFlavor |
Observation.participant:participant2.typeCode | required | Fixed Value: CST |
Observation.participant:participant2.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant2.participantRole.classCode | required | Fixed Value: AGNT |
Observation.participant:participant2.participantRole.code | preferred | Personal And Legal Relationship Role Type |
Observation.participant:participant2.participantRole.playingEntity.classCode | required | EntityClassRoot |
Observation.participant:participant2.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Observation.participant:participant2.participantRole.playingEntity.code | preferred | Healthcare Agent Qualifier |
Observation.reference:reference1.nullFlavor | required | NullFlavor |
Observation.reference:reference1.typeCode | required | Fixed Value: REFR |
Observation.reference:reference1.externalDocument.classCode | required | ActClassDocument |
Observation.reference:reference1.externalDocument.moodCode | required | Fixed Value: EVN |
Observation.reference:reference1.externalDocument.code | extensible | FHIRDocumentTypeCodes |
Observation.reference:reference1.externalDocument.text.nullFlavor | required | NullFlavor |
Observation.reference:reference1.externalDocument.text.compression | required | CompressionAlgorithm |
Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.referenceRange.nullFlavor | required | NullFlavor |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
1198-8666 | warning | Observation.participant:participant1.time | The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). : | |
1198-8698 | warning | Observation.reference:reference1.externalDocument.text.reference | The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). : | |
1198-8699 | warning | Observation.reference:reference1.externalDocument.text.reference | If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). : | |
1198-32449 | error | Observation.effectiveTime.high | If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). : | |
1198-32493 | error | Observation.value | If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). : | |
81-7296 | error | Observation.participant:participant1.participantRole.addr, Observation.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
81-9371 | error | Observation.participant:participant1.participantRole.playingEntity.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
81-9372 | error | Observation.participant:participant1.participantRole.playingEntity.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
pn-no-ls | error | Observation.participant:participant1.participantRole.playingEntity.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 19 elements (7 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: