{
"description": "This Care Experience Preference template represents a person's care preferences during their care and treatment. Examples include, but are not limited to religious preferences, dislikes and fears, and thoughts and feelings to be shared. This templates does not represent actual order, but holds observations about wishes. These observations may inform the placement of future orders. While observation.code is encoded to support system queries, the answers represented at observation.value are likely to be text. Precondition.Criterion is recommended to represent the situations when a person would prefer the stated care experiences, such as during childbirth or interventional procedures.\\nThis template may be used directly in any section, such as Care Plan Document Sections, Social History, or Advance Directives, and may be used inside any entry such as Procedure or Medication Activity.",
"_filename": "StructureDefinition-CareExperiencePreference.json",
"package_name": "hl7.cda.us.ccda",
"date": "2023-12-21T01:13:10+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "CareExperiencePreference",
"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": "Care Experience Preference",
"package_version": "3.0.0-ballot",
"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/CareExperiencePreference",
"severity": "warning",
"expression": "text.reference.value.exists()"
}, {
"key": "should-sdtcPrecondition2",
"human": "SHOULD contain sdtc:Precondition2",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference",
"severity": "warning",
"expression": "sdtcPrecondition2.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:care-experience-pref",
"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": "care-experience-pref",
"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:care-experience-pref.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:care-experience-pref.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:care-experience-pref.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.509",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "Observation.templateId:care-experience-pref.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": "2024-05-01",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Observation.templateId:care-experience-pref.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://terminology.hl7.org/ValueSet/v3-ActClassObservation|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Observation.classCode",
"base": {
"max": "1",
"min": 1,
"path": "Observation.classCode"
}
}, {
"path": "Observation.moodCode",
"fixedCode": "INT",
"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",
"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"
} ]
}, {
"path": "Observation.code",
"min": 1,
"short": "Care Experience Preference",
"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",
"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": "95541-9",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "Observation.code.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "Observation.code.codeSystem",
"min": 1,
"definition": "Specifies the code system that defines the code.",
"short": "LOINC",
"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.6.1",
"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"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "Observation.code.translation",
"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": 0,
"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/CareExperiencePreference",
"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": 0,
"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"
}
}, {
"id": "Observation.effectiveTime",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Observation.effectiveTime"
},
"path": "Observation.effectiveTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
} ]
}, {
"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"
}
}, {
"id": "Observation.value",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Observation.value"
},
"path": "Observation.value",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"short": "Most of the time, the value will be a string representing the person's words.",
"representation": [ "typeAttr" ]
}, {
"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://terminology.hl7.org/ValueSet/v3-ObservationInterpretation"
}
}, {
"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"
} ]
}, {
"id": "Observation.author",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.author"
},
"path": "Observation.author",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/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"
} ]
}, {
"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"
} ]
}, {
"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": 0,
"base": {
"max": "*",
"min": 0,
"path": "Observation.reference"
},
"path": "Observation.reference",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
} ]
}, {
"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"
} ],
"constraint": [ {
"key": "should-criterion",
"human": "SHOULD contain criterion",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference",
"severity": "warning",
"expression": "criterion.exists()"
} ]
}, {
"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://terminology.hl7.org/ValueSet/v3-ActRelationshipType|2.0.0"
},
"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": "26f5af70-a9d4-4047-86a0-38395336f455",
"kind": "logical",
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference",
"identifier": [ {
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.509:2024-05-01"
} ],
"version": "3.0.0-ballot",
"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/CareExperiencePreference",
"severity": "warning",
"expression": "text.reference.value.exists()"
}, {
"key": "should-sdtcPrecondition2",
"human": "SHOULD contain sdtc:Precondition2",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference",
"severity": "warning",
"expression": "sdtcPrecondition2.exists()"
} ]
}, {
"id": "Observation.templateId",
"min": 1,
"path": "Observation.templateId",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
}
}, {
"id": "Observation.templateId:care-experience-pref",
"max": "1",
"min": 1,
"path": "Observation.templateId",
"sliceName": "care-experience-pref"
}, {
"id": "Observation.templateId:care-experience-pref.root",
"min": 1,
"path": "Observation.templateId.root",
"patternString": "2.16.840.1.113883.10.20.22.4.509"
}, {
"id": "Observation.templateId:care-experience-pref.extension",
"min": 1,
"path": "Observation.templateId.extension",
"patternString": "2024-05-01"
}, {
"id": "Observation.classCode",
"path": "Observation.classCode",
"fixedCode": "OBS"
}, {
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"fixedCode": "INT"
}, {
"id": "Observation.id",
"min": 1,
"path": "Observation.id"
}, {
"id": "Observation.code",
"path": "Observation.code",
"short": "Care Experience Preference"
}, {
"id": "Observation.code.code",
"min": 1,
"path": "Observation.code.code",
"patternCode": "95541-9"
}, {
"id": "Observation.code.codeSystem",
"min": 1,
"path": "Observation.code.codeSystem",
"short": "LOINC",
"patternString": "2.16.840.1.113883.6.1"
}, {
"id": "Observation.text",
"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/CareExperiencePreference",
"severity": "error",
"expression": "value.exists() implies value.startsWith('#')"
} ]
}, {
"id": "Observation.value",
"max": "1",
"min": 1,
"path": "Observation.value",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"short": "Most of the time, the value will be a string representing the person's words."
}, {
"id": "Observation.sdtcPrecondition2",
"path": "Observation.sdtcPrecondition2",
"constraint": [ {
"key": "should-criterion",
"human": "SHOULD contain criterion",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference",
"severity": "warning",
"expression": "criterion.exists()"
} ]
} ]
},
"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"
}