{
"description": "Advance Directive Observations may include a variety of information called different “content types”. The set of Advance Directive Observations within an Advance Directive Organizer provides a summarization of relevant information available in an external Advance Healthcare Directive document or gathered as a result of a conversation with the patient or their healthcare agent (Advance Directive document or Portable Medical Order document).\\n\\n\\nThe types of content in an advance directive could include, but are not limited to:\\n* Healthcare agent consent\\n* Resuscitation procedure preference\\n* Intubation and Ventilation procedure preference\\n* Antibiotics or other medication administration preference\\n* Artificial nutrition or hydration administration preference\\n* Diagnostic Testing procedure preference\\n* Preferences relating to palliative care\\n* Preferences relating to hospice care \\n* Organ donation preference\\n* Autopsy procedure preference\\n* Burial or funeral preference\\n* Care preference that is general in nature which the patient wants care providers to take into consideration, such as likes or dislikes related to the experience of receiving care\\n* Information about a personal goal, such as seeing a grandchild born, attending a child’s wedding, finding care for a beloved pet, or dying in a certain place.\\n\\nPreferences can be for or against certain procedures and are typically conditional based upon a certain health scenario taking place.\\n\\nThe type of content in a portable medical order could include but are not limited to procedures that can be ordered such as cardiopulmonary resuscitation, hospital transfer, full/selected/comfort care, antibiotics administration, artificial nutrition and hydration administration, dialysis, intubation, ventilation, and more.\\n\\nAdvance directives are effective when the individual is unable to communicate with their medical team themselves, due to a health crisis or emergency, and persist from execution until such time as the condition of the individual renders them appropriate for use. The effectiveTime/low tells when they went into effect (or will go into effect) and the high tells when they ceased or will cease to be in effect. If the starting effective time is not known, effectiveTime/low is UNK, but this would still be considered “Active”. At a minimum the starting effective time is the date signed. If effectiveTime/high contains a value of “NA” or it is not valued, the advance directive remains active until some action is taken to make it inactive, such as updating the document contents or revocation of the document itself. (Explicit use of nullFlavor=”NA” is the preferred approach for indicating an Advance Directive that is not time bounded.) That action may update the existing information with an effectiveTime/high or it may replace the open-ended entry with a new entry that includes the effectiveTime/high information. An advance directive is active so long as the effectiveTime/high has not been passed.\\n\\nThe author of the Advance Directive Observation is the person documenting that the directives were reviewed and verified to be accurate for provision of treatment and care. The verifier is the person who read the document and verified the advance directive information. The role of verifier and the role of author need not be fulfilled by the same person, so each role is documented separately. However, the author and the verifier often will be the same person in advance healthcare directive documents that are NOT portable medical orders. This template supports Context Conduction. The author of the organizer can be assumed to be the author of the Advance Directive Observations within the organizer unless explicitly overridden within the contained observation. When author identity confidence is high, implementers should explicitly assert conformance to the Provenance Author Participation template.\\n\\nAdvance Directive Observations that would appear in the context of an Advance Directive Organizer:\\n\\n| Information Content Type (as evidenced in an external document, or provided verbally during a patient encounter and not contained in an external document) | How the Observation is used to represent this information for exchange |\\n| --- | --- |\\n| Existing advance healthcare directive document | Observation.code = 75320
Observation.code.translation = 92183-3 (Form type)
Observation.value = a code from Advance Healthcare Directive Categories
Optional: entryRelationship to reference the external source document by identifier |\\n| Appointment of healthcare agents that are consented to by the patient.| Observation.code = 75320
Observation.code.translation = 81335-2
Observation.value = a code from Healthcare Agent or Proxy Choices
If no healthcare agents are appointed, Observation.value/@nullflavor = a code from No Healthcare Agent Included Reason
Observation.participant is used to record an appointed healthcare agent. Each Advance Directive Observation of this type holds only one Healthcare Agent, necessitating that if a primary healthcare agent and a backup healthcare agent are designed two Advance Directive Observation entries are required. |\\n| Patient’s Treatment Intervention Preferences (also supports preconditional health scenarios), Care Experience Preferences, and Upon Death Preferences. | When documenting that a patient has documented or expressed Treatment Intervention Preferences, Care Experience Preferences, or Upon Death Preferences, the person verifying the content in the referenced document is the performer of the observation and the observation.value tells what type of content was verified or discussed.
The documented preference is included as a reference to the Treatment Intervention Preference, Care Experience Preference or Upon Death Preference identified in the source document.
The verified current preference can be included as entryRelationships to a Treatment Intervention Preference or Care Experience Preference where the performer is the person verifying the information with the patient or the healthcare agent, the informant is the patient or healthcare agent, and the author is the person recording this documentation in the EHR.
Observation.code = 75320
Observation.code.translation = 95541-9 Care Experience Preference
81378-2 Personal Intervention Preference
81337-8 Upon Death Preferences
Observation.value = code from Advance Directive Content Type |\\n| Personal healthcare goals (also supports preconditional health scenarios) | Observation.code = 75320
Observation.code.translation = 87528-6 Personal Health Goal
Observation.value = a code from Health Goals at End of Life Grouping |\\n| Practitioner Orders that are in place in a Portable Medical Order document. | Observation.code = 75320
Observation.code.translation = Code should come from CPT or SNOMED CT codes.
Observation.value will be from a specialized value set including coded values appropriate for the specific order. Or if coded concepts are not available, Observation.value will be a Boolean where T = perform and F=do-not-perform |\\n{:.grid}\\n\\nAdvance Directive Observation that would not be contained in the context of an Advance Directive Organizer:\\n\\n| Information Content Type (as evidenced in an external document, or provided verbally during a patient encounter and not contained in an external document) | How the Observation is used to represent this information for exchange |\\n| --- | --- |\\n| Advance Directive Observation authored by the organization creating the C-CDA document to show the Patient’s DNR Status. | Observation.code = 75320
Observation.code.translation = 100822-6 Cardiopulmonary resuscitation orders
Observation.value will be LA33470-8 (Yes CPR) or LA33471-6 (No CPR) |\\n{:.grid}",
"_filename": "StructureDefinition-AdvanceDirectiveObservation.json",
"package_name": "hl7.cda.us.ccda",
"date": "2024-05-18T00:16:25-05:00",
"derivation": "constraint",
"publisher": "Health Level Seven",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "AdvanceDirectiveObservation",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Advance Directive Observation",
"package_version": "3.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
} ]
}
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "observation"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri": "cda"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "should-text-ref-value",
"human": "SHOULD contain text/reference/@value",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "text.reference.value.exists()"
}, {
"key": "should-author",
"human": "SHOULD contain author",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "author.exists()"
}, {
"key": "should-informant",
"human": "SHOULD contain informant",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "informant.exists()"
} ],
"path": "Observation",
"min": 1,
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "Observation",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"path": "Observation.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.templateId",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"id": "Observation.templateId:advance-directive-obs",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "advance-directive-obs",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.templateId:advance-directive-obs.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.templateId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.templateId:advance-directive-obs.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.templateId:advance-directive-obs.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.10.20.22.4.48",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "Observation.templateId:advance-directive-obs.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.templateId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"patternString": "2022-02-14",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.templateId:advance-directive-obs.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"path": "Observation.classCode",
"fixedCode": "OBS",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC).",
"base": {
"max": "1",
"min": 1,
"path": "Observation.classCode"
}
}, {
"path": "Observation.moodCode",
"fixedCode": "EVN",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.moodCode",
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).",
"base": {
"max": "1",
"min": 1,
"path": "Observation.moodCode"
}
}, {
"id": "Observation.negationInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.negationInd"
},
"path": "Observation.negationInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"id": "Observation.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Observation.id"
},
"path": "Observation.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "SHALL contain at least one [1..*] id."
}, {
"constraint": [ {
"key": "should-translation",
"human": "SHOULD contain translation",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "translation.exists()"
} ],
"path": "Observation.code",
"min": 1,
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationType"
},
"representation": [ "typeAttr" ],
"max": "1",
"id": "Observation.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:3250-16895).",
"base": {
"max": "1",
"min": 1,
"path": "Observation.code"
}
}, {
"path": "Observation.code.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.code.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.code.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"patternCode": "75320-2",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "Observation.code.code",
"comment": "This code SHALL contain exactly one [1..1] @code=\"75320-2\" Advance directive (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:3250-16940).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "Observation.code.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "Observation.code.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "Observation.code.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "Observation.code.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "Observation.code.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "Observation.code.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "Observation.code.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "Observation.code.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "Observation.code.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.code.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "Observation.code.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.code.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "Observation.code.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "Observation.code.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "Observation.code.qualifier",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "Observation.code.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "Observation.code.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4"
},
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "Observation.code.translation",
"comment": "This code SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Advance Directives Categories urn:oid:2.16.840.1.113883.11.20.9.69.4.",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "Observation.derivationExpr",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.derivationExpr"
},
"path": "Observation.derivationExpr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
} ]
}, {
"id": "Observation.text",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Observation.text"
},
"path": "Observation.text",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"short": "SHOULD reference the portion of section narrative text corresponding to this entry",
"representation": [ "typeAttr" ]
}, {
"path": "Observation.text.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.text.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.text.compression",
"min": 0,
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Compression",
"id": "Observation.text.compression",
"base": {
"max": "1",
"min": 0,
"path": "ED.compression"
}
}, {
"path": "Observation.text.integrityCheck",
"min": 0,
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"type": [ {
"code": "base64Binary",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bin" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Integrity Check",
"id": "Observation.text.integrityCheck",
"base": {
"max": "1",
"min": 0,
"path": "ED.integrityCheck"
}
}, {
"path": "Observation.text.integrityCheckAlgorithm",
"min": 0,
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Integrity Check Algorithm",
"id": "Observation.text.integrityCheckAlgorithm",
"base": {
"max": "1",
"min": 0,
"path": "ED.integrityCheckAlgorithm"
}
}, {
"path": "Observation.text.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "Observation.text.language",
"base": {
"max": "1",
"min": 0,
"path": "ED.language"
}
}, {
"path": "Observation.text.mediaType",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "Observation.text.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ED.mediaType"
}
}, {
"id": "Observation.text.representation",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ED.representation"
},
"path": "Observation.text.representation",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
},
"representation": [ "xmlAttr" ]
}, {
"path": "Observation.text.xmlText",
"min": 0,
"definition": "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
"short": "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "Observation.text.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ED.xmlText"
}
}, {
"constraint": [ {
"key": "value-starts-octothorpe",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "value.exists() implies value.startsWith('#')"
} ],
"path": "Observation.text.reference",
"min": 0,
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"max": "1",
"label": "Reference",
"id": "Observation.text.reference",
"base": {
"max": "1",
"min": 0,
"path": "ED.reference"
}
}, {
"id": "Observation.text.thumbnail",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ED.thumbnail"
},
"path": "Observation.text.thumbnail",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference."
}, {
"id": "Observation.statusCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Observation.statusCode"
},
"path": "Observation.statusCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
},
"comment": "SHALL contain exactly one [1..1] statusCode (CONF:1198-8652)."
}, {
"path": "Observation.statusCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.statusCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.statusCode.code",
"fixedCode": "completed",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "Observation.statusCode.code",
"comment": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19082).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "Observation.statusCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "Observation.statusCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "Observation.statusCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "Observation.statusCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "Observation.statusCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "Observation.statusCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "Observation.statusCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "Observation.statusCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "Observation.statusCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.statusCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "Observation.statusCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.statusCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "Observation.statusCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "Observation.statusCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "Observation.statusCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "Observation.statusCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "Observation.statusCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "Observation.statusCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "Observation.effectiveTime",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Observation.effectiveTime"
},
"path": "Observation.effectiveTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
} ],
"comment": "SHALL contain exactly one [1..1] effectiveTime."
}, {
"path": "Observation.effectiveTime.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.effectiveTime.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.effectiveTime.value",
"min": 0,
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"type": [ {
"code": "dateTime",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.effectiveTime.value",
"base": {
"max": "1",
"min": 0,
"path": "TS.value"
}
}, {
"path": "Observation.effectiveTime.operator",
"min": 0,
"definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"defaultValueCode": "I",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.effectiveTime.operator",
"base": {
"max": "1",
"min": 0,
"path": "SXCM_TS.operator"
}
}, {
"path": "Observation.effectiveTime.low",
"min": 1,
"definition": "This is the low limit of the interval.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"max": "1",
"label": "Low Boundary",
"id": "Observation.effectiveTime.low",
"comment": "This effectiveTime SHALL contain exactly one [1..1] low.",
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.low"
}
}, {
"id": "Observation.effectiveTime.center",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.center"
},
"path": "Observation.effectiveTime.center",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"label": "Central Value",
"definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values."
}, {
"id": "Observation.effectiveTime.width",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.width"
},
"path": "Observation.effectiveTime.width",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
} ],
"label": "Width",
"definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived."
}, {
"constraint": [ {
"key": "1198-32449",
"human": "If the Advance Directive does not have a specified ending time, the element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "value.exists() or nullFlavor = 'NA'"
} ],
"path": "Observation.effectiveTime.high",
"min": 1,
"definition": "This is the high limit of the interval.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"max": "1",
"label": "High Boundary",
"id": "Observation.effectiveTime.high",
"comment": "This effectiveTime SHALL contain exactly one [1..1] high.",
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.high"
}
}, {
"id": "Observation.priorityCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.priorityCode"
},
"path": "Observation.priorityCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
}, {
"id": "Observation.repeatNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.repeatNumber"
},
"path": "Observation.repeatNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT"
} ]
}, {
"id": "Observation.languageCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.languageCode"
},
"path": "Observation.languageCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"path": "Observation.value",
"min": 1,
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.57",
"description": "Advance Directive Content Type"
},
"representation": [ "typeAttr" ],
"max": "1",
"id": "Observation.value",
"comment": "SHALL contain exactly one [1..1] value (CONF:1198-30804).",
"base": {
"max": "*",
"min": 0,
"path": "Observation.value"
}
}, {
"id": "Observation.interpretationCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.interpretationCode"
},
"path": "Observation.interpretationCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation"
}
}, {
"id": "Observation.methodCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.methodCode"
},
"path": "Observation.methodCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationMethod"
}
}, {
"id": "Observation.targetSiteCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.targetSiteCode"
},
"path": "Observation.targetSiteCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"definition": "Drawn from concept domain ActSite"
}, {
"id": "Observation.subject",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.subject"
},
"path": "Observation.subject",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
} ]
}, {
"id": "Observation.specimen",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.specimen"
},
"path": "Observation.specimen",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
} ]
}, {
"id": "Observation.performer",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.performer"
},
"path": "Observation.performer",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
} ]
}, {
"path": "Observation.author",
"min": 0,
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation" ]
} ],
"max": "*",
"id": "Observation.author",
"comment": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119).",
"base": {
"max": "*",
"min": 0,
"path": "Observation.author"
}
}, {
"id": "Observation.informant",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.informant"
},
"path": "Observation.informant",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
} ],
"short": "SHOULD contain informant"
}, {
"id": "Observation.participant",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.participant"
},
"path": "Observation.participant",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "typeCode",
"type": "value"
} ]
}
}, {
"constraint": [ {
"key": "should-time",
"human": "SHOULD contain time",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "time.exists()"
} ],
"path": "Observation.participant",
"min": 0,
"short": "The participant \"VRF\" represents the clinician(s) who verified the patient advance directive.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
} ],
"sliceName": "verifier",
"max": "*",
"id": "Observation.participant:verifier",
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1198-8662) such that it",
"base": {
"max": "*",
"min": 0,
"path": "Observation.participant"
}
}, {
"path": "Observation.participant.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:verifier.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:verifier.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:verifier.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:verifier.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:verifier.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:verifier.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:verifier.templateId",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
} ]
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.templateId",
"min": 1,
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "primary",
"max": "1",
"id": "Observation.participant:verifier.templateId:primary",
"comment": "SHALL contain exactly one [1..1] templateId (CONF:1198-8664) such that it",
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
}
}, {
"path": "Observation.participant.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.templateId:primary.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.templateId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:verifier.templateId:primary.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:verifier.templateId:primary.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.10.20.1.58",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "Observation.participant:verifier.templateId:primary.root",
"comment": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.1.58\" (CONF:1198-10486).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.templateId.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Extension",
"id": "Observation.participant:verifier.templateId:primary.extension",
"comment": "SHALL not contain [0..0] extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"path": "Observation.participant.typeCode",
"fixedCode": "VRF",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"VRF\" Verifier (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8663).",
"base": {
"max": "1",
"min": 1,
"path": "Participant2.typeCode"
}
}, {
"path": "Observation.participant.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Participant2.contextControlCode"
}
}, {
"id": "Observation.participant:verifier.sdtcFunctionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.sdtcFunctionCode"
},
"path": "Observation.participant.sdtcFunctionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "functionCode"
} ]
}, {
"id": "Observation.participant:verifier.time",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.time"
},
"path": "Observation.participant.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
} ],
"comment": "SHOULD contain zero or one [0..1] time (CONF:1198-8665).",
"constraint": [ {
"key": "value-only",
"human": "Interval fields SHALL not be present",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "(low | high | width | center).empty()"
} ]
}, {
"path": "Observation.participant.time.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.time.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.time.value",
"min": 0,
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"short": "value should be used instead of low/high",
"type": [ {
"code": "dateTime",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.time.value",
"base": {
"max": "1",
"min": 0,
"path": "TS.value"
}
}, {
"path": "Observation.participant.time.operator",
"min": 0,
"definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"defaultValueCode": "I",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.time.operator",
"base": {
"max": "1",
"min": 0,
"path": "SXCM_TS.operator"
}
}, {
"id": "Observation.participant:verifier.time.low",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.low"
},
"path": "Observation.participant.time.low",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"label": "Low Boundary",
"definition": "This is the low limit of the interval."
}, {
"id": "Observation.participant:verifier.time.center",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.center"
},
"path": "Observation.participant.time.center",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"label": "Central Value",
"definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values."
}, {
"id": "Observation.participant:verifier.time.width",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.width"
},
"path": "Observation.participant.time.width",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
} ],
"label": "Width",
"definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived."
}, {
"id": "Observation.participant:verifier.time.high",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.high"
},
"path": "Observation.participant.time.high",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"label": "High Boundary",
"definition": "This is the high limit of the interval."
}, {
"id": "Observation.participant:verifier.awarenessCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.awarenessCode"
},
"path": "Observation.participant.awarenessCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "Observation.participant:verifier.participantRole",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Participant2.participantRole"
},
"path": "Observation.participant.participantRole",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole"
} ],
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1198-8825).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"path": "Observation.participant.participantRole.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.participantRole.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:verifier.participantRole.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.participantRole.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:verifier.participantRole.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.participantRole.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.participantRole.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.participantRole.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.participantRole.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:verifier.participantRole.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.participantRole.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:verifier.participantRole.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.participantRole.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:verifier.participantRole.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.participantRole.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:verifier.participantRole.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:verifier.participantRole.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.participantRole.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.participantRole.classCode",
"min": 0,
"defaultValueCode": "ROL",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.participantRole.classCode",
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.classCode"
}
}, {
"id": "Observation.participant:verifier.participantRole.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.id"
},
"path": "Observation.participant.participantRole.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.sdtcIdentifiedBy"
},
"path": "Observation.participant.participantRole.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.code"
},
"path": "Observation.participant.participantRole.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-28446)."
}, {
"constraint": [ {
"key": "shall-city",
"human": "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or item.city.count() = 1"
}, {
"key": "shall-streetAddressLine",
"human": "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)"
}, {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
}, {
"key": "should-country",
"human": "SHOULD contain country",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "warning",
"expression": "nullFlavor.exists() or item.country.exists()"
}, {
"key": "81-7296",
"human": "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "item.xmlText.empty()"
}, {
"key": "81-10024",
"human": "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))"
}, {
"key": "81-10025",
"human": "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))"
}, {
"key": "shall-max-ad-parts",
"human": "SHALL have at most one of each: state, city, postalCode, and country",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)"
} ],
"path": "Observation.participant.participantRole.addr",
"min": 0,
"definition": "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"max": "*",
"id": "Observation.participant:verifier.participantRole.addr",
"comment": "This participantRole MAY contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-28451).",
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.addr"
}
}, {
"id": "Observation.participant:verifier.participantRole.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.telecom"
},
"path": "Observation.participant.participantRole.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.playingDevice",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.playingDevice"
},
"path": "Observation.participant.participantRole.playingDevice",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Device"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.playingEntity"
},
"path": "Observation.participant.participantRole.playingEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity"
} ],
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1198-28428)."
}, {
"path": "Observation.participant.participantRole.playingEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.participantRole.playingEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.participantRole.playingEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.participantRole.playingEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:verifier.participantRole.playingEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.participantRole.playingEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.participantRole.playingEntity.classCode",
"min": 0,
"defaultValueCode": "ENT",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.participantRole.playingEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.classCode"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:verifier.participantRole.playingEntity.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.determinerCode"
}
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.code"
},
"path": "Observation.participant.participantRole.playingEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.quantity",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "PlayingEntity.quantity"
},
"path": "Observation.participant.participantRole.playingEntity.quantity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
} ]
}, {
"constraint": [ {
"key": "pn-no-ls",
"human": "No PN name part may have a qualifier of LS.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"severity": "error",
"expression": "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()"
}, {
"key": "81-9371",
"human": "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED",
"severity": "error",
"expression": "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()"
}, {
"key": "81-9372",
"human": "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED",
"severity": "error",
"expression": "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()"
} ],
"path": "Observation.participant.participantRole.playingEntity.name",
"min": 1,
"definition": "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"max": "1",
"id": "Observation.participant:verifier.participantRole.playingEntity.name",
"comment": "The playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-28454).",
"base": {
"max": "*",
"min": 0,
"path": "PlayingEntity.name"
}
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.sdtcBirthTime",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.sdtcBirthTime"
},
"path": "Observation.participant.participantRole.playingEntity.sdtcBirthTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "birthTime"
} ],
"definition": "The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient."
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.desc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.desc"
},
"path": "Observation.participant.participantRole.playingEntity.desc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.scopingEntity",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.scopingEntity"
},
"path": "Observation.participant.participantRole.scopingEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entity"
} ]
}, {
"path": "Observation.participant",
"min": 0,
"short": "This custodian (CST) participant identifies a legal representative for healthcare decision-making. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. Only record a healthcare agent who is acting in that capacitiy and participating in carae decision-making during the documented care encounter.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
} ],
"sliceName": "custodian",
"max": "*",
"id": "Observation.participant:custodian",
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1198-8667) such that it",
"base": {
"max": "*",
"min": 0,
"path": "Observation.participant"
}
}, {
"path": "Observation.participant.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:custodian.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:custodian.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:custodian.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:custodian.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:custodian.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:custodian.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:custodian.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.typeCode",
"fixedCode": "CST",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:custodian.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"CST\" Custodian (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8668).",
"base": {
"max": "1",
"min": 1,
"path": "Participant2.typeCode"
}
}, {
"path": "Observation.participant.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:custodian.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Participant2.contextControlCode"
}
}, {
"id": "Observation.participant:custodian.sdtcFunctionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.sdtcFunctionCode"
},
"path": "Observation.participant.sdtcFunctionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "functionCode"
} ]
}, {
"id": "Observation.participant:custodian.time",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.time"
},
"path": "Observation.participant.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
} ]
}, {
"id": "Observation.participant:custodian.awarenessCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant2.awarenessCode"
},
"path": "Observation.participant.awarenessCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "Observation.participant:custodian.participantRole",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Participant2.participantRole"
},
"path": "Observation.participant.participantRole",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole"
} ],
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1198-8669).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
}, {
"key": "should-addr",
"human": "SHOULD contain addr",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "addr.exists()"
}, {
"key": "should-telecom",
"human": "SHOULD contain telecom",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "telecom.exists()"
} ]
}, {
"path": "Observation.participant.participantRole.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.participantRole.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:custodian.participantRole.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.participantRole.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:custodian.participantRole.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.participantRole.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.participantRole.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.participantRole.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.participantRole.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:custodian.participantRole.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.participantRole.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:custodian.participantRole.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.participantRole.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:custodian.participantRole.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.participantRole.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:custodian.participantRole.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:custodian.participantRole.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.participantRole.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.participantRole.classCode",
"fixedCode": "AGNT",
"min": 1,
"defaultValueCode": "ROL",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:custodian.participantRole.classCode",
"comment": "This participantRole SHALL contain exactly one [1..1] @classCode=\"AGNT\" Agent (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1198-8670).",
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.classCode"
}
}, {
"id": "Observation.participant:custodian.participantRole.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.id"
},
"path": "Observation.participant.participantRole.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.sdtcIdentifiedBy"
},
"path": "Observation.participant.participantRole.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.code"
},
"path": "Observation.participant.participantRole.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1046.35"
},
"comment": "This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Agent or Proxy Choices urn:oid:2.16.840.1.113762.1.4.1046.35 DYNAMIC (CONF:1198-28440)."
}, {
"constraint": [ {
"key": "shall-city",
"human": "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or item.city.count() = 1"
}, {
"key": "shall-streetAddressLine",
"human": "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)"
}, {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
}, {
"key": "should-country",
"human": "SHOULD contain country",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "warning",
"expression": "nullFlavor.exists() or item.country.exists()"
}, {
"key": "81-7296",
"human": "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "item.xmlText.empty()"
}, {
"key": "81-10024",
"human": "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))"
}, {
"key": "81-10025",
"human": "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))"
}, {
"key": "shall-max-ad-parts",
"human": "SHALL have at most one of each: state, city, postalCode, and country",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress",
"severity": "error",
"expression": "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)"
} ],
"path": "Observation.participant.participantRole.addr",
"min": 0,
"definition": "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"max": "1",
"id": "Observation.participant:custodian.participantRole.addr",
"comment": "This participantRole SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8671).",
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.addr"
}
}, {
"id": "Observation.participant:custodian.participantRole.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ParticipantRole.telecom"
},
"path": "Observation.participant.participantRole.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This participantRole SHOULD contain zero or more [0..*] telecom (CONF:1198-8672)."
}, {
"id": "Observation.participant:custodian.participantRole.playingDevice",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.playingDevice"
},
"path": "Observation.participant.participantRole.playingDevice",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Device"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.playingEntity"
},
"path": "Observation.participant.participantRole.playingEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity"
} ],
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1198-8824).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"path": "Observation.participant.participantRole.playingEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.participantRole.playingEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.participant.participantRole.playingEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.participant.participantRole.playingEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.participant:custodian.participantRole.playingEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.participant.participantRole.playingEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.participant.participantRole.playingEntity.classCode",
"min": 0,
"defaultValueCode": "ENT",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:custodian.participantRole.playingEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.classCode"
}
}, {
"path": "Observation.participant.participantRole.playingEntity.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.participant:custodian.participantRole.playingEntity.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.determinerCode"
}
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.code"
},
"path": "Observation.participant.participantRole.playingEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
},
"comment": "This playingEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal and Legal Relationship RoleType urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC."
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.quantity",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "PlayingEntity.quantity"
},
"path": "Observation.participant.participantRole.playingEntity.quantity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.name",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "PlayingEntity.name"
},
"path": "Observation.participant.participantRole.playingEntity.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN"
} ],
"short": "The name of the healthcare agent.",
"comment": "This playingEntity SHALL contain exactly one [1..1] name (CONF:1198-8673)."
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.sdtcBirthTime",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.sdtcBirthTime"
},
"path": "Observation.participant.participantRole.playingEntity.sdtcBirthTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "birthTime"
} ],
"definition": "The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient."
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.desc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PlayingEntity.desc"
},
"path": "Observation.participant.participantRole.playingEntity.desc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.scopingEntity",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ParticipantRole.scopingEntity"
},
"path": "Observation.participant.participantRole.scopingEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entity"
} ]
}, {
"id": "Observation.entryRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.entryRelationship"
},
"path": "Observation.entryRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
} ]
}, {
"id": "Observation.reference",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Observation.reference"
},
"path": "Observation.reference",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "typeCode",
"type": "value"
} ]
}
}, {
"id": "Observation.reference:reference1",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Observation.reference"
},
"path": "Observation.reference",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
} ],
"comment": "SHOULD contain at least one [1..*] reference (CONF:1198-8692) such that it",
"sliceName": "reference1"
}, {
"path": "Observation.reference.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.reference:reference1.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.reference:reference1.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.reference.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.reference:reference1.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.reference.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.reference.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.reference:reference1.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.reference.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.reference:reference1.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.reference.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.reference:reference1.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.reference.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.reference:reference1.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.reference.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.reference:reference1.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.reference:reference1.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.reference.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.reference.typeCode",
"fixedCode": "REFR",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.reference:reference1.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"REFR\" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8694).",
"base": {
"max": "1",
"min": 1,
"path": "Reference.typeCode"
}
}, {
"id": "Observation.reference:reference1.seperatableInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Reference.seperatableInd"
},
"path": "Observation.reference.seperatableInd",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
} ]
}, {
"id": "Observation.reference:reference1.externalAct",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Reference.externalAct"
},
"path": "Observation.reference.externalAct",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct"
} ]
}, {
"id": "Observation.reference:reference1.externalObservation",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Reference.externalObservation"
},
"path": "Observation.reference.externalObservation",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation"
} ]
}, {
"id": "Observation.reference:reference1.externalProcedure",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Reference.externalProcedure"
},
"path": "Observation.reference.externalProcedure",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure"
} ]
}, {
"id": "Observation.reference:reference1.externalDocument",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Reference.externalDocument"
},
"path": "Observation.reference.externalDocument",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument"
} ],
"comment": "SHALL contain exactly one [1..1] externalDocument (CONF:1198-8693)."
}, {
"path": "Observation.reference.externalDocument.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.reference:reference1.externalDocument.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.reference:reference1.externalDocument.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.reference.externalDocument.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.reference:reference1.externalDocument.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.reference.externalDocument.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.reference.externalDocument.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.reference:reference1.externalDocument.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.reference.externalDocument.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.reference:reference1.externalDocument.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.reference.externalDocument.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.reference:reference1.externalDocument.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.reference.externalDocument.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.reference:reference1.externalDocument.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.reference.externalDocument.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.reference:reference1.externalDocument.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.reference:reference1.externalDocument.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.reference.externalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.reference.externalDocument.classCode",
"min": 0,
"defaultValueCode": "DOC",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassDocument"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.reference:reference1.externalDocument.classCode",
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.classCode"
}
}, {
"path": "Observation.reference.externalDocument.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.reference:reference1.externalDocument.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.moodCode"
}
}, {
"id": "Observation.reference:reference1.externalDocument.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "ExternalDocument.id"
},
"path": "Observation.reference.externalDocument.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This externalDocument SHALL contain at least one [1..*] id (CONF:1198-8695)."
}, {
"id": "Observation.reference:reference1.externalDocument.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.code"
},
"path": "Observation.reference.externalDocument.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4"
}
}, {
"id": "Observation.reference:reference1.externalDocument.text",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.text"
},
"path": "Observation.reference.externalDocument.text",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"comment": "This externalDocument MAY contain zero or one [0..1] text (CONF:1198-8696)."
}, {
"path": "Observation.reference.externalDocument.text.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.reference:reference1.externalDocument.text.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.reference.externalDocument.text.compression",
"min": 0,
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Compression",
"id": "Observation.reference:reference1.externalDocument.text.compression",
"base": {
"max": "1",
"min": 0,
"path": "ED.compression"
}
}, {
"path": "Observation.reference.externalDocument.text.integrityCheck",
"min": 0,
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"type": [ {
"code": "base64Binary",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bin" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Integrity Check",
"id": "Observation.reference:reference1.externalDocument.text.integrityCheck",
"base": {
"max": "1",
"min": 0,
"path": "ED.integrityCheck"
}
}, {
"path": "Observation.reference.externalDocument.text.integrityCheckAlgorithm",
"min": 0,
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Integrity Check Algorithm",
"id": "Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithm",
"base": {
"max": "1",
"min": 0,
"path": "ED.integrityCheckAlgorithm"
}
}, {
"path": "Observation.reference.externalDocument.text.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "Observation.reference:reference1.externalDocument.text.language",
"base": {
"max": "1",
"min": 0,
"path": "ED.language"
}
}, {
"path": "Observation.reference.externalDocument.text.mediaType",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "Observation.reference:reference1.externalDocument.text.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ED.mediaType"
}
}, {
"id": "Observation.reference:reference1.externalDocument.text.representation",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ED.representation"
},
"path": "Observation.reference.externalDocument.text.representation",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
},
"representation": [ "xmlAttr" ]
}, {
"path": "Observation.reference.externalDocument.text.xmlText",
"min": 0,
"definition": "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
"short": "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "Observation.reference:reference1.externalDocument.text.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ED.xmlText"
}
}, {
"constraint": [ {
"key": "1198-8699",
"human": "If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning"
} ],
"path": "Observation.reference.externalDocument.text.reference",
"min": 0,
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"short": "The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"max": "1",
"label": "Reference",
"id": "Observation.reference:reference1.externalDocument.text.reference",
"comment": "The text, if present, MAY contain zero or one [0..1] reference (CONF:1198-8697).",
"base": {
"max": "1",
"min": 0,
"path": "ED.reference"
}
}, {
"id": "Observation.reference:reference1.externalDocument.text.thumbnail",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ED.thumbnail"
},
"path": "Observation.reference.externalDocument.text.thumbnail",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference."
}, {
"id": "Observation.reference:reference1.externalDocument.setId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.setId"
},
"path": "Observation.reference.externalDocument.setId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Observation.reference:reference1.externalDocument.versionNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.versionNumber"
},
"path": "Observation.reference.externalDocument.versionNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
} ]
}, {
"id": "Observation.precondition",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.precondition"
},
"path": "Observation.precondition",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
} ]
}, {
"id": "Observation.sdtcPrecondition2",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.sdtcPrecondition2"
},
"path": "Observation.sdtcPrecondition2",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "precondition2"
} ]
}, {
"id": "Observation.referenceRange",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.referenceRange"
},
"path": "Observation.referenceRange",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"definition": "Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified."
}, {
"path": "Observation.referenceRange.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.referenceRange.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Observation.referenceRange.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Observation.referenceRange.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "Observation.referenceRange.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Observation.referenceRange.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "Observation.referenceRange.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Observation.referenceRange.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Observation.referenceRange.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Observation.referenceRange.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Observation.referenceRange.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Observation.referenceRange.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Observation.referenceRange.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Observation.referenceRange.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Observation.referenceRange.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.referenceRange.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Observation.referenceRange.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Observation.referenceRange.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"
}, {
"path": "Observation.referenceRange.typeCode",
"fixedCode": "REFV",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.referenceRange.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Observation.referenceRange.typeCode"
}
}, {
"id": "Observation.referenceRange.observationRange",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Observation.referenceRange.observationRange"
},
"path": "Observation.referenceRange.observationRange",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange"
} ]
}, {
"id": "Observation.sdtcInFulfillmentOf1",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.sdtcInFulfillmentOf1"
},
"path": "Observation.sdtcInFulfillmentOf1",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "inFulfillmentOf1"
} ]
} ]
},
"status": "draft",
"id": "f986a001-dc25-40f3-a91c-5e1520594864",
"kind": "logical",
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"identifier": [ {
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2022-02-14",
"system": "urn:ietf:rfc:3986"
} ],
"version": "3.0.0",
"differential": {
"element": [ {
"id": "Observation",
"path": "Observation",
"constraint": [ {
"key": "should-text-ref-value",
"human": "SHOULD contain text/reference/@value",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "text.reference.value.exists()"
}, {
"key": "should-author",
"human": "SHOULD contain author",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "author.exists()"
}, {
"key": "should-informant",
"human": "SHOULD contain informant",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "informant.exists()"
} ]
}, {
"id": "Observation.templateId",
"min": 1,
"path": "Observation.templateId",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
}
}, {
"id": "Observation.templateId:advance-directive-obs",
"max": "1",
"min": 1,
"path": "Observation.templateId",
"sliceName": "advance-directive-obs"
}, {
"id": "Observation.templateId:advance-directive-obs.root",
"min": 1,
"path": "Observation.templateId.root",
"patternString": "2.16.840.1.113883.10.20.22.4.48"
}, {
"id": "Observation.templateId:advance-directive-obs.extension",
"min": 1,
"path": "Observation.templateId.extension",
"patternString": "2022-02-14"
}, {
"id": "Observation.classCode",
"path": "Observation.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC).",
"fixedCode": "OBS"
}, {
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).",
"fixedCode": "EVN"
}, {
"id": "Observation.id",
"min": 1,
"path": "Observation.id",
"comment": "SHALL contain at least one [1..*] id."
}, {
"id": "Observation.code",
"path": "Observation.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:3250-16895).",
"constraint": [ {
"key": "should-translation",
"human": "SHOULD contain translation",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "translation.exists()"
} ]
}, {
"id": "Observation.code.code",
"min": 1,
"path": "Observation.code.code",
"comment": "This code SHALL contain exactly one [1..1] @code=\"75320-2\" Advance directive (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:3250-16940).",
"patternCode": "75320-2"
}, {
"id": "Observation.code.translation",
"path": "Observation.code.translation",
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4"
},
"comment": "This code SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Advance Directives Categories urn:oid:2.16.840.1.113883.11.20.9.69.4."
}, {
"id": "Observation.text",
"min": 1,
"path": "Observation.text",
"short": "SHOULD reference the portion of section narrative text corresponding to this entry"
}, {
"id": "Observation.text.reference",
"path": "Observation.text.reference",
"constraint": [ {
"key": "value-starts-octothorpe",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "value.exists() implies value.startsWith('#')"
} ]
}, {
"id": "Observation.statusCode",
"min": 1,
"path": "Observation.statusCode",
"comment": "SHALL contain exactly one [1..1] statusCode (CONF:1198-8652)."
}, {
"id": "Observation.statusCode.code",
"min": 1,
"path": "Observation.statusCode.code",
"comment": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19082).",
"fixedCode": "completed"
}, {
"id": "Observation.effectiveTime",
"min": 1,
"path": "Observation.effectiveTime",
"comment": "SHALL contain exactly one [1..1] effectiveTime."
}, {
"id": "Observation.effectiveTime.low",
"min": 1,
"path": "Observation.effectiveTime.low",
"comment": "This effectiveTime SHALL contain exactly one [1..1] low."
}, {
"id": "Observation.effectiveTime.high",
"min": 1,
"path": "Observation.effectiveTime.high",
"comment": "This effectiveTime SHALL contain exactly one [1..1] high.",
"constraint": [ {
"key": "1198-32449",
"human": "If the Advance Directive does not have a specified ending time, the element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "value.exists() or nullFlavor = 'NA'"
} ]
}, {
"id": "Observation.value",
"max": "1",
"min": 1,
"path": "Observation.value",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.57",
"description": "Advance Directive Content Type"
},
"comment": "SHALL contain exactly one [1..1] value (CONF:1198-30804)."
}, {
"id": "Observation.author",
"path": "Observation.author",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation" ]
} ],
"comment": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119)."
}, {
"id": "Observation.informant",
"path": "Observation.informant",
"short": "SHOULD contain informant"
}, {
"id": "Observation.participant",
"path": "Observation.participant",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "typeCode",
"type": "value"
} ]
}
}, {
"id": "Observation.participant:verifier",
"max": "*",
"min": 0,
"path": "Observation.participant",
"short": "The participant \"VRF\" represents the clinician(s) who verified the patient advance directive.",
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1198-8662) such that it",
"sliceName": "verifier",
"constraint": [ {
"key": "should-time",
"human": "SHOULD contain time",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "time.exists()"
} ]
}, {
"id": "Observation.participant:verifier.templateId",
"min": 1,
"path": "Observation.participant.templateId",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
} ]
}
}, {
"id": "Observation.participant:verifier.templateId:primary",
"max": "1",
"min": 1,
"path": "Observation.participant.templateId",
"comment": "SHALL contain exactly one [1..1] templateId (CONF:1198-8664) such that it",
"sliceName": "primary"
}, {
"id": "Observation.participant:verifier.templateId:primary.root",
"min": 1,
"path": "Observation.participant.templateId.root",
"comment": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.1.58\" (CONF:1198-10486).",
"patternString": "2.16.840.1.113883.10.20.1.58"
}, {
"id": "Observation.participant:verifier.templateId:primary.extension",
"max": "0",
"path": "Observation.participant.templateId.extension",
"comment": "SHALL not contain [0..0] extension"
}, {
"id": "Observation.participant:verifier.typeCode",
"path": "Observation.participant.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"VRF\" Verifier (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8663).",
"fixedCode": "VRF"
}, {
"id": "Observation.participant:verifier.time",
"path": "Observation.participant.time",
"comment": "SHOULD contain zero or one [0..1] time (CONF:1198-8665).",
"constraint": [ {
"key": "value-only",
"human": "Interval fields SHALL not be present",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "error",
"expression": "(low | high | width | center).empty()"
} ]
}, {
"id": "Observation.participant:verifier.time.value",
"path": "Observation.participant.time.value",
"short": "value should be used instead of low/high"
}, {
"id": "Observation.participant:verifier.participantRole",
"path": "Observation.participant.participantRole",
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1198-8825).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"id": "Observation.participant:verifier.participantRole.code",
"path": "Observation.participant.participantRole.code",
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-28446)."
}, {
"id": "Observation.participant:verifier.participantRole.addr",
"path": "Observation.participant.participantRole.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "This participantRole MAY contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-28451)."
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity",
"min": 1,
"path": "Observation.participant.participantRole.playingEntity",
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1198-28428)."
}, {
"id": "Observation.participant:verifier.participantRole.playingEntity.name",
"max": "1",
"min": 1,
"path": "Observation.participant.participantRole.playingEntity.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "The playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-28454)."
}, {
"id": "Observation.participant:custodian",
"max": "*",
"min": 0,
"path": "Observation.participant",
"short": "This custodian (CST) participant identifies a legal representative for healthcare decision-making. Examples of such individuals are called health care agents, substitute decision makers and/or health care proxies. Only record a healthcare agent who is acting in that capacitiy and participating in carae decision-making during the documented care encounter.",
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1198-8667) such that it",
"sliceName": "custodian"
}, {
"id": "Observation.participant:custodian.typeCode",
"path": "Observation.participant.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"CST\" Custodian (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8668).",
"fixedCode": "CST"
}, {
"id": "Observation.participant:custodian.participantRole",
"path": "Observation.participant.participantRole",
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1198-8669).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
}, {
"key": "should-addr",
"human": "SHOULD contain addr",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "addr.exists()"
}, {
"key": "should-telecom",
"human": "SHOULD contain telecom",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "telecom.exists()"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.classCode",
"min": 1,
"path": "Observation.participant.participantRole.classCode",
"comment": "This participantRole SHALL contain exactly one [1..1] @classCode=\"AGNT\" Agent (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1198-8670).",
"fixedCode": "AGNT"
}, {
"id": "Observation.participant:custodian.participantRole.code",
"path": "Observation.participant.participantRole.code",
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1046.35"
},
"comment": "This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Agent or Proxy Choices urn:oid:2.16.840.1.113762.1.4.1046.35 DYNAMIC (CONF:1198-28440)."
}, {
"id": "Observation.participant:custodian.participantRole.addr",
"max": "1",
"path": "Observation.participant.participantRole.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "This participantRole SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8671)."
}, {
"id": "Observation.participant:custodian.participantRole.telecom",
"path": "Observation.participant.participantRole.telecom",
"comment": "This participantRole SHOULD contain zero or more [0..*] telecom (CONF:1198-8672)."
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity",
"min": 1,
"path": "Observation.participant.participantRole.playingEntity",
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1198-8824).",
"constraint": [ {
"key": "should-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.code",
"path": "Observation.participant.participantRole.playingEntity.code",
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
},
"comment": "This playingEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal and Legal Relationship RoleType urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC."
}, {
"id": "Observation.participant:custodian.participantRole.playingEntity.name",
"max": "1",
"min": 1,
"path": "Observation.participant.participantRole.playingEntity.name",
"short": "The name of the healthcare agent.",
"comment": "This playingEntity SHALL contain exactly one [1..1] name (CONF:1198-8673)."
}, {
"id": "Observation.reference",
"min": 1,
"path": "Observation.reference",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "typeCode",
"type": "value"
} ]
}
}, {
"id": "Observation.reference:reference1",
"max": "*",
"min": 1,
"path": "Observation.reference",
"comment": "SHOULD contain at least one [1..*] reference (CONF:1198-8692) such that it",
"sliceName": "reference1"
}, {
"id": "Observation.reference:reference1.typeCode",
"path": "Observation.reference.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"REFR\" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8694).",
"fixedCode": "REFR"
}, {
"id": "Observation.reference:reference1.externalDocument",
"min": 1,
"path": "Observation.reference.externalDocument",
"comment": "SHALL contain exactly one [1..1] externalDocument (CONF:1198-8693)."
}, {
"id": "Observation.reference:reference1.externalDocument.id",
"min": 1,
"path": "Observation.reference.externalDocument.id",
"comment": "This externalDocument SHALL contain at least one [1..*] id (CONF:1198-8695)."
}, {
"id": "Observation.reference:reference1.externalDocument.code",
"min": 1,
"path": "Observation.reference.externalDocument.code",
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4"
}
}, {
"id": "Observation.reference:reference1.externalDocument.text",
"path": "Observation.reference.externalDocument.text",
"comment": "This externalDocument MAY contain zero or one [0..1] text (CONF:1198-8696)."
}, {
"id": "Observation.reference:reference1.externalDocument.text.reference",
"path": "Observation.reference.externalDocument.text.reference",
"short": "The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698).",
"comment": "The text, if present, MAY contain zero or one [0..1] reference (CONF:1198-8697).",
"constraint": [ {
"key": "1198-8699",
"human": "If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveObservation",
"severity": "warning"
} ]
} ]
},
"contact": [ {
"name": "HL7 International - Structured Documents",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/structure",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
}