{ "description": "An assessment scale is a collection of observations that together can yield a calculated or non-calculated summary evaluation of a one or more conditions. Examples include the Braden Scale (assesses pressure ulcer risk), APACHE Score (estimates mortality in critically ill patients), Mini-Mental Status Exam (assesses cognitive function), APGAR Score (assesses the health of a newborn), Glasgow Coma Scale (assesses coma and impaired consciousness), and WE CARE (Well Child Care, Evaluation, Community Resources, Advocacy, Referral, Education - a clinic-based screening and referral system developed for pediatric settings).\\n\\nWhen an Assessment Scale Observation is contained in a Problem Observation, a Social History Observation or a Procedure instance that is Social Determinant of Health focused, that Assessment scale **MAY** contain assessment scale observations that represent question and answer pairs from SDOH screening instruments that are represented in LOINC. Note that guidance on the use of LOINC in assessment scales already exists in Assessment Scale Observation constraints and Assessment Scale Supporting Observations constraints.\\n\\nThe Observation value is used to record a calculated score using an integer. A LOINC answer concept is used when the assessment is non-calculated result.", "_filename": "StructureDefinition-AssessmentScaleObservation.json", "package_name": "hl7.cda.us.ccda", "date": "2024-12-20T09:02:06+11:00", "derivation": "constraint", "publisher": "Health Level Seven", "fhirVersion": "5.0.0", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] } ], "name": "AssessmentScaleObservation", "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": "Assessment Scale Observation", "package_version": "4.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/AssessmentScaleObservation", "severity": "warning", "expression": "text.reference.value.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" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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:assessment-scale-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": "assessment-scale-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:assessment-scale-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:assessment-scale-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:assessment-scale-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.69", "representation": [ "xmlAttr" ], "max": "1", "label": "Root", "id": "Observation.templateId:assessment-scale-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-06-01", "representation": [ "xmlAttr" ], "max": "1", "label": "Extension", "id": "Observation.templateId:assessment-scale-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\" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-14434).", "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\" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4515-14435).", "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 (CONF:4515-14438)." }, { "id": "Observation.sdtcCategory", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "Observation.sdtcCategory" }, "path": "Observation.sdtcCategory", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "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": "category" } ] }, { "constraint": [ { "key": "should-translation", "human": "SHOULD contain translation", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "translation.exists()" } ], "path": "Observation.code", "min": 1, "short": "survey", "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": "survey", "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": "Observation Category Codes", "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.4.642.1.1125", "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.113762.1.4.1267.13", "additional": [ { "purpose": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.206", "shortDoco": "For Social Determinant of Health Assessments", "documentation": "If the Assessment Scale Observation is a Social Determinant of Health Assessment, the observation code **SHOULD** be selected from ValueSet [Social Determinant of Health Assessments and Questions](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.206/expansion)." } ] }, "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" } ], "short": "Such derivation expression can contain a text calculation of how the components total up to the summed score", "comment": "MAY contain zero or one [0..1] derivationExpr (CONF:4515-14637)." }, { "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/AssessmentScaleObservation", "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:4515-14444)." }, { "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:4515-19088).", "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" } ], "short": "Represents clinically effective time of the measurement, which may be when the measurement was performed (e.g., a BP measurement), or may be when sample was taken (and measured some time afterwards)", "comment": "SHALL contain exactly one [1..1] effectiveTime (CONF:4515-14445)." }, { "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, "short": "Intended to hold the calculated score, if a calculated score exists in the originating questionaire or scale from the contained Assessment Scale Observations, and the associated answer integer will be at observation.value.translationCode, if present", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ANY" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CV" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CO" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SC" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/REAL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/MO" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ" } ], "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "representation": [ "typeAttr" ], "max": "1", "id": "Observation.value", "comment": "SHALL contain exactly one [1..1] value (CONF:4515-14450).", "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" }, "comment": "MAY contain zero or more [0..*] interpretationCode (CONF:4515-14459)." }, { "path": "Observation.interpretationCode.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.interpretationCode.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Observation.interpretationCode.code", "min": 0, "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.interpretationCode.code", "base": { "max": "1", "min": 0, "path": "CD.code" } }, { "path": "Observation.interpretationCode.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.interpretationCode.codeSystem", "base": { "max": "1", "min": 0, "path": "CD.codeSystem" } }, { "path": "Observation.interpretationCode.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.interpretationCode.codeSystemName", "base": { "max": "1", "min": 0, "path": "CD.codeSystemName" } }, { "path": "Observation.interpretationCode.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.interpretationCode.codeSystemVersion", "base": { "max": "1", "min": 0, "path": "CD.codeSystemVersion" } }, { "path": "Observation.interpretationCode.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.interpretationCode.displayName", "base": { "max": "1", "min": 0, "path": "CD.displayName" } }, { "path": "Observation.interpretationCode.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.interpretationCode.sdtcValueSet", "base": { "max": "1", "min": 0, "path": "CD.valueSet" } }, { "path": "Observation.interpretationCode.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.interpretationCode.sdtcValueSetVersion", "base": { "max": "1", "min": 0, "path": "CD.sdtcValueSetVersion" } }, { "id": "Observation.interpretationCode.originalText", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "CD.originalText" }, "path": "Observation.interpretationCode.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.interpretationCode.qualifier", "max": "0", "min": 0, "base": { "max": "*", "min": 0, "path": "CD.qualifier" }, "path": "Observation.interpretationCode.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.interpretationCode.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.interpretationCode.translation", "comment": "The interpretationCode, if present, MAY contain zero or more [0..*] translation (CONF:4515-14888).", "base": { "max": "*", "min": 0, "path": "CD.translation" } }, { "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" } ], "comment": "MAY contain zero or more [0..*] author (CONF:4515-14460)." }, { "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" } ], "comment": "SHOULD contain zero or more [0..*] entryRelationship (CONF:4515-14451) such that it", "slicing": { "rules": "open", "discriminator": [ { "path": "observation", "type": "profile" }, { "path": "typeCode", "type": "value" } ] } }, { "id": "Observation.entryRelationship:supportingObs", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "Observation.entryRelationship" }, "path": "Observation.entryRelationship", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship" } ], "short": "entryRelationship", "sliceName": "supportingObs" }, { "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "id": "Observation.entryRelationship:supportingObs.realmCode", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.realmCode" }, "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.typeId", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "InfrastructureRoot.typeId" }, "path": "Observation.entryRelationship.typeId", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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.entryRelationship.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.entryRelationship:supportingObs.typeId.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.typeId.assigningAuthorityName", "base": { "max": "1", "min": 0, "path": "II.assigningAuthorityName" } }, { "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.typeId.displayable", "base": { "max": "1", "min": 0, "path": "II.displayable" } }, { "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.typeId.root", "base": { "max": "1", "min": 0, "path": "II.root" } }, { "path": "Observation.entryRelationship.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.entryRelationship:supportingObs.typeId.extension", "base": { "max": "1", "min": 0, "path": "II.extension" } }, { "id": "Observation.entryRelationship:supportingObs.templateId", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.templateId" }, "path": "Observation.entryRelationship.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.entryRelationship.typeCode", "fixedCode": "COMP", "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-xActRelationshipEntryRelationship" }, "representation": [ "xmlAttr" ], "max": "1", "id": "Observation.entryRelationship:supportingObs.typeCode", "comment": "SHALL contain exactly one [1..1] @typeCode=\"COMP\" has component (CONF:4515-16741).", "base": { "max": "1", "min": 1, "path": "EntryRelationship.typeCode" } }, { "id": "Observation.entryRelationship:supportingObs.inversionInd", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.inversionInd" }, "path": "Observation.entryRelationship.inversionInd", "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.", "representation": [ "xmlAttr" ] }, { "path": "Observation.entryRelationship.contextConductionInd", "min": 0, "definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.", "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "defaultValueBoolean": true, "representation": [ "xmlAttr" ], "max": "1", "id": "Observation.entryRelationship:supportingObs.contextConductionInd", "base": { "max": "1", "min": 0, "path": "EntryRelationship.contextConductionInd" } }, { "id": "Observation.entryRelationship:supportingObs.negationInd", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.negationInd" }, "path": "Observation.entryRelationship.negationInd", "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "representation": [ "xmlAttr" ] }, { "id": "Observation.entryRelationship:supportingObs.sequenceNumber", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.sequenceNumber" }, "path": "Observation.entryRelationship.sequenceNumber", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" } ] }, { "id": "Observation.entryRelationship:supportingObs.seperatableInd", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.seperatableInd" }, "path": "Observation.entryRelationship.seperatableInd", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" } ] }, { "id": "Observation.entryRelationship:supportingObs.act", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.act" }, "path": "Observation.entryRelationship.act", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Act" } ] }, { "id": "Observation.entryRelationship:supportingObs.encounter", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.encounter" }, "path": "Observation.entryRelationship.encounter", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter" } ] }, { "id": "Observation.entryRelationship:supportingObs.observation", "max": "1", "min": 1, "base": { "max": "1", "min": 0, "path": "EntryRelationship.observation" }, "path": "Observation.entryRelationship.observation", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleSupportingObservation" ] } ], "comment": "SHALL contain exactly one [1..1] Assessment Scale Supporting Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.86) (CONF:4515-16742)." }, { "id": "Observation.entryRelationship:supportingObs.observationMedia", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.observationMedia" }, "path": "Observation.entryRelationship.observationMedia", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia" } ] }, { "id": "Observation.entryRelationship:supportingObs.organizer", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.organizer" }, "path": "Observation.entryRelationship.organizer", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer" } ] }, { "id": "Observation.entryRelationship:supportingObs.procedure", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.procedure" }, "path": "Observation.entryRelationship.procedure", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure" } ] }, { "id": "Observation.entryRelationship:supportingObs.regionOfInterest", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.regionOfInterest" }, "path": "Observation.entryRelationship.regionOfInterest", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest" } ] }, { "id": "Observation.entryRelationship:supportingObs.substanceAdministration", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.substanceAdministration" }, "path": "Observation.entryRelationship.substanceAdministration", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration" } ] }, { "id": "Observation.entryRelationship:supportingObs.supply", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EntryRelationship.supply" }, "path": "Observation.entryRelationship.supply", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply" } ] }, { "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" } ] }, { "path": "Observation.referenceRange", "min": 0, "definition": "Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.", "short": "The referenceRange/observationRange/text, if present, MAY contain a description of the scale (e.g., for a Pain Scale 1 to 10: 1 to 3 = little pain, 4 to 7 = moderate pain, 8 to 10 = severe pain)", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" } ], "max": "*", "id": "Observation.referenceRange", "comment": "MAY contain zero or more [0..*] referenceRange (CONF:4515-16799).", "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" } }, { "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" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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" } ], "comment": "The referenceRange, if present, SHALL contain exactly one [1..1] observationRange (CONF:4515-16800).", "constraint": [ { "key": "should-text", "human": "SHOULD contain text", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "text.exists()" }, { "key": "should-text-ref-value", "human": "SHOULD contain text/reference/@value", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "text.reference.value.exists()" } ] }, { "path": "Observation.referenceRange.observationRange.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.observationRange.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "id": "Observation.referenceRange.observationRange.realmCode", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.realmCode" }, "path": "Observation.referenceRange.observationRange.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.observationRange.typeId", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "InfrastructureRoot.typeId" }, "path": "Observation.referenceRange.observationRange.typeId", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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.observationRange.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.observationRange.typeId.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Observation.referenceRange.observationRange.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.observationRange.typeId.assigningAuthorityName", "base": { "max": "1", "min": 0, "path": "II.assigningAuthorityName" } }, { "path": "Observation.referenceRange.observationRange.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.observationRange.typeId.displayable", "base": { "max": "1", "min": 0, "path": "II.displayable" } }, { "path": "Observation.referenceRange.observationRange.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.observationRange.typeId.root", "base": { "max": "1", "min": 0, "path": "II.root" } }, { "path": "Observation.referenceRange.observationRange.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.observationRange.typeId.extension", "base": { "max": "1", "min": 0, "path": "II.extension" } }, { "id": "Observation.referenceRange.observationRange.templateId", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.templateId" }, "path": "Observation.referenceRange.observationRange.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.observationRange.classCode", "min": 0, "defaultValueCode": "OBS", "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.referenceRange.observationRange.classCode", "base": { "max": "1", "min": 0, "path": "ObservationRange.classCode" } }, { "path": "Observation.referenceRange.observationRange.moodCode", "fixedCode": "EVN.CRT", "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-ActMoodPredicate" }, "representation": [ "xmlAttr" ], "max": "1", "id": "Observation.referenceRange.observationRange.moodCode", "base": { "max": "1", "min": 0, "path": "ObservationRange.moodCode" } }, { "id": "Observation.referenceRange.observationRange.code", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ObservationRange.code" }, "path": "Observation.referenceRange.observationRange.code", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, { "id": "Observation.referenceRange.observationRange.text", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ObservationRange.text" }, "path": "Observation.referenceRange.observationRange.text", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" } ], "short": "The text may contain a description of the scale (e.g., for a Pain Scale 1 to 10: 1 to 3 = little pain, 4 to 7= moderate pain, 8 to 10 = severe pain)", "comment": "This observationRange SHOULD contain zero or one [0..1] text (CONF:4515-16801)." }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.compression", "base": { "max": "1", "min": 0, "path": "ED.compression" } }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.integrityCheck", "base": { "max": "1", "min": 0, "path": "ED.integrityCheck" } }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.integrityCheckAlgorithm", "base": { "max": "1", "min": 0, "path": "ED.integrityCheckAlgorithm" } }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.language", "base": { "max": "1", "min": 0, "path": "ED.language" } }, { "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.mediaType", "base": { "max": "1", "min": 0, "path": "ED.mediaType" } }, { "id": "Observation.referenceRange.observationRange.text.representation", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ED.representation" }, "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.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.referenceRange.observationRange.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/AssessmentScaleObservation", "severity": "error", "expression": "value.exists() implies value.startsWith('#')" } ], "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.text.reference", "base": { "max": "1", "min": 0, "path": "ED.reference" } }, { "id": "Observation.referenceRange.observationRange.text.thumbnail", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ED.thumbnail" }, "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.value", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ObservationRange.value" }, "path": "Observation.referenceRange.observationRange.value", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CV" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CO" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SC" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/REAL" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/MO" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS" }, { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS" } ], "representation": [ "typeAttr" ] }, { "id": "Observation.referenceRange.observationRange.interpretationCode", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "ObservationRange.interpretationCode" }, "path": "Observation.referenceRange.observationRange.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.referenceRange.observationRange.sdtcPrecondition1", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "ObservationRange.sdtcPrecondition1" }, "path": "Observation.referenceRange.observationRange.sdtcPrecondition1", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" } ], "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": "precondition1" } ], "definition": "The sdtc:precondition1 extension allows for the association of a criterion with a reference range (ObservationRange), which allows the expression in a lab report that a reference range is conditional on some criterion such as patient sex or age (or a combination of criterion)." }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "id": "Observation.referenceRange.observationRange.sdtcPrecondition1.realmCode", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.realmCode" }, "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "InfrastructureRoot.typeId" }, "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.typeId", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId.assigningAuthorityName", "base": { "max": "1", "min": 0, "path": "II.assigningAuthorityName" } }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId.displayable", "base": { "max": "1", "min": 0, "path": "II.displayable" } }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId.root", "base": { "max": "1", "min": 0, "path": "II.root" } }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeId.extension", "base": { "max": "1", "min": 0, "path": "II.extension" } }, { "id": "Observation.referenceRange.observationRange.sdtcPrecondition1.templateId", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.templateId" }, "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.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.observationRange.sdtcPrecondition1.typeCode", "fixedCode": "PRCN", "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.observationRange.sdtcPrecondition1.typeCode", "base": { "max": "1", "min": 0, "path": "ObservationRange.sdtcPrecondition1.typeCode" } }, { "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCode", "min": 1, "definition": "A code specifying the logical conjunction of the criteria among all the condition-links of Acts (e.g., and, or, exclusive-or).\n\nAll AND criteria must be true.\n\nIf OR and AND criteria occur together, one criterion out of the OR-group must be true and all AND criteria must be true also.\n\nIf XOR criteria occur together with OR and AND criteria, exactly one of the XOR criteria must be true, and at least one of the OR criteria and all AND criteria must be true.\n\nIn other words, the sets of AND, OR, and XOR criteria are in turn combined by a logical AND operator (all AND criteria and at least one OR criterion and exactly one XOR criterion).", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS" } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:sdtc" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-RelationshipConjunction|2.0.0" }, "max": "1", "id": "Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCode", "base": { "max": "1", "min": 1, "path": "ObservationRange.sdtcPrecondition1.conjunctionCode" } }, { "id": "Observation.referenceRange.observationRange.sdtcPrecondition1.criterion1", "max": "1", "min": 1, "base": { "max": "1", "min": 1, "path": "ObservationRange.sdtcPrecondition1.criterion1" }, "path": "Observation.referenceRange.observationRange.sdtcPrecondition1.criterion1", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Criterion" } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:sdtc" } ] }, { "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": "cef86621-d382-4c1a-aec0-aa54ff6af225", "kind": "logical", "url": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "identifier": [ { "value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.69:2022-06-01", "system": "urn:ietf:rfc:3986" } ], "version": "4.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/AssessmentScaleObservation", "severity": "warning", "expression": "text.reference.value.exists()" } ] }, { "id": "Observation.templateId", "min": 1, "path": "Observation.templateId", "slicing": { "rules": "open", "discriminator": [ { "path": "root", "type": "value" }, { "path": "extension", "type": "value" } ] } }, { "id": "Observation.templateId:assessment-scale-obs", "max": "1", "min": 1, "path": "Observation.templateId", "sliceName": "assessment-scale-obs" }, { "id": "Observation.templateId:assessment-scale-obs.root", "min": 1, "path": "Observation.templateId.root", "patternString": "2.16.840.1.113883.10.20.22.4.69" }, { "id": "Observation.templateId:assessment-scale-obs.extension", "min": 1, "path": "Observation.templateId.extension", "patternString": "2022-06-01" }, { "id": "Observation.classCode", "path": "Observation.classCode", "comment": "SHALL contain exactly one [1..1] @classCode=\"OBS\" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-14434).", "fixedCode": "OBS" }, { "id": "Observation.moodCode", "path": "Observation.moodCode", "comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4515-14435).", "fixedCode": "EVN" }, { "id": "Observation.id", "min": 1, "path": "Observation.id", "comment": "SHALL contain at least one [1..*] id (CONF:4515-14438)." }, { "id": "Observation.code", "path": "Observation.code", "short": "survey", "constraint": [ { "key": "should-translation", "human": "SHOULD contain translation", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "translation.exists()" } ] }, { "id": "Observation.code.code", "min": 1, "path": "Observation.code.code", "patternCode": "survey" }, { "id": "Observation.code.codeSystem", "min": 1, "path": "Observation.code.codeSystem", "short": "Observation Category Codes", "patternString": "2.16.840.1.113883.4.642.1.1125" }, { "id": "Observation.code.translation", "path": "Observation.code.translation", "binding": { "strength": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.13", "additional": [ { "purpose": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.206", "shortDoco": "For Social Determinant of Health Assessments", "documentation": "If the Assessment Scale Observation is a Social Determinant of Health Assessment, the observation code **SHOULD** be selected from ValueSet [Social Determinant of Health Assessments and Questions](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.206/expansion)." } ] } }, { "id": "Observation.derivationExpr", "path": "Observation.derivationExpr", "short": "Such derivation expression can contain a text calculation of how the components total up to the summed score", "comment": "MAY contain zero or one [0..1] derivationExpr (CONF:4515-14637)." }, { "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/AssessmentScaleObservation", "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:4515-14444)." }, { "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:4515-19088).", "fixedCode": "completed" }, { "id": "Observation.effectiveTime", "min": 1, "path": "Observation.effectiveTime", "short": "Represents clinically effective time of the measurement, which may be when the measurement was performed (e.g., a BP measurement), or may be when sample was taken (and measured some time afterwards)", "comment": "SHALL contain exactly one [1..1] effectiveTime (CONF:4515-14445)." }, { "id": "Observation.value", "max": "1", "min": 1, "path": "Observation.value", "short": "Intended to hold the calculated score, if a calculated score exists in the originating questionaire or scale from the contained Assessment Scale Observations, and the associated answer integer will be at observation.value.translationCode, if present", "comment": "SHALL contain exactly one [1..1] value (CONF:4515-14450).", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ] }, { "id": "Observation.interpretationCode", "path": "Observation.interpretationCode", "comment": "MAY contain zero or more [0..*] interpretationCode (CONF:4515-14459)." }, { "id": "Observation.interpretationCode.translation", "path": "Observation.interpretationCode.translation", "comment": "The interpretationCode, if present, MAY contain zero or more [0..*] translation (CONF:4515-14888)." }, { "id": "Observation.author", "path": "Observation.author", "comment": "MAY contain zero or more [0..*] author (CONF:4515-14460)." }, { "id": "Observation.entryRelationship", "path": "Observation.entryRelationship", "comment": "SHOULD contain zero or more [0..*] entryRelationship (CONF:4515-14451) such that it", "slicing": { "rules": "open", "discriminator": [ { "path": "observation", "type": "profile" }, { "path": "typeCode", "type": "value" } ] } }, { "id": "Observation.entryRelationship:supportingObs", "max": "*", "min": 0, "path": "Observation.entryRelationship", "short": "entryRelationship", "sliceName": "supportingObs" }, { "id": "Observation.entryRelationship:supportingObs.typeCode", "path": "Observation.entryRelationship.typeCode", "comment": "SHALL contain exactly one [1..1] @typeCode=\"COMP\" has component (CONF:4515-16741).", "fixedCode": "COMP" }, { "id": "Observation.entryRelationship:supportingObs.observation", "min": 1, "path": "Observation.entryRelationship.observation", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleSupportingObservation" ] } ], "comment": "SHALL contain exactly one [1..1] Assessment Scale Supporting Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.86) (CONF:4515-16742)." }, { "id": "Observation.referenceRange", "path": "Observation.referenceRange", "short": "The referenceRange/observationRange/text, if present, MAY contain a description of the scale (e.g., for a Pain Scale 1 to 10: 1 to 3 = little pain, 4 to 7 = moderate pain, 8 to 10 = severe pain)", "comment": "MAY contain zero or more [0..*] referenceRange (CONF:4515-16799)." }, { "id": "Observation.referenceRange.observationRange", "path": "Observation.referenceRange.observationRange", "comment": "The referenceRange, if present, SHALL contain exactly one [1..1] observationRange (CONF:4515-16800).", "constraint": [ { "key": "should-text", "human": "SHOULD contain text", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "text.exists()" }, { "key": "should-text-ref-value", "human": "SHOULD contain text/reference/@value", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleObservation", "severity": "warning", "expression": "text.reference.value.exists()" } ] }, { "id": "Observation.referenceRange.observationRange.text", "path": "Observation.referenceRange.observationRange.text", "short": "The text may contain a description of the scale (e.g., for a Pain Scale 1 to 10: 1 to 3 = little pain, 4 to 7= moderate pain, 8 to 10 = severe pain)", "comment": "This observationRange SHOULD contain zero or one [0..1] text (CONF:4515-16801)." }, { "id": "Observation.referenceRange.observationRange.text.reference", "path": "Observation.referenceRange.observationRange.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/AssessmentScaleObservation", "severity": "error", "expression": "value.exists() implies value.startsWith('#')" } ] } ] }, "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" }