FHIR IG Statistics: StructureDefinition/2.16.840.1.113883.10.20.22.4.38
| Package | hl7.cda.us.ccdar2dot2 |
| Type | StructureDefinition |
| Id | 2.16.840.1.113883.10.20.22.4.38 |
| FHIR Version | R4 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda-2.2/StructureDefinition-2.16.840.1.113883.10.20.22.4.38.html |
| URL | http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.38 |
| Version | 2.2 |
| Status | active |
| Date | 2022-05-13T15:50:12+00:00 |
| Name | SocialHistoryObservation |
| Title | Social History Observation |
| Realm | us |
| Authority | hl7 |
| Description | This template represents a patient's occupations, lifestyle, and environmental health risk factors. Demographic data (e.g., marital status, race, ethnicity, religious affiliation) are captured in the header. Though tobacco use and exposure may be represented with a Social History Observation, it is recommended to use the Current Smoking Status template or the Tobacco Use template instead, to represent smoking or tobacco habits. |
| Type | Observation |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|
  Observation | | 1..1 | CDAR2.Observation | |
  classCode | | 1..1 | code | Required Pattern: OBS |
| moodCode | | 1..1 | code | Required Pattern: EVN |
 Slices for templateId | | 0..* | II | Slice: Unordered, Open by value:extension, value:root |
   templateId:primary | | 1..1 | II | |
  root | | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.38 |
  extension | | 1..1 | string | Required Pattern: 2015-08-01 |
| id | | 1..* | II | |
| code | I | 1..1 | CD | Binding: Social History Type (preferred)
1198-32951: If @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32951). |
| statusCode | | 1..1 | CS | |
 code | | 1..1 | string | Required Pattern: completed |
| effectiveTime | | 1..1 | IVL_TS | |
| value | I | 0..1 | BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | 1198-8555: If Observation/value is a physical quantity (xsi:type="PQ"), the unit of measure **SHALL** be selected from ValueSet UnitsOfMeasureCaseSensitive (2.16.840.1.113883.1.11.12839) *DYNAMIC* (CONF:1198-8555). |
| author | | 0..* | AuthorParticipation | |
Documentation for this format |
Source
{
"resourceType": "StructureDefinition",
"id": "2.16.840.1.113883.10.20.22.4.38",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.38",
"identifier": [
{
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.38:2015-08-01"
}
],
"version": "2.2",
"name": "SocialHistoryObservation",
"title": "Social History Observation",
"status": "active",
"date": "2022-05-13T15:50:12+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "This template represents a patient's occupations, lifestyle, and environmental health risk factors. Demographic data (e.g., marital status, race, ethnicity, religious affiliation) are captured in the header. Though tobacco use and exposure may be represented with a Social History Observation, it is recommended to use the Current Smoking Status template or the Tobacco Use template instead, to represent smoking or tobacco habits.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Observation",
"baseDefinition": "http://hl7.org/fhir/cda/StructureDefinition/Observation",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Observation",
"path": "Observation",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Observation.classCode",
"path": "Observation.classCode",
"representation": [
"xmlAttr"
],
"requirements": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8548).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"patternCode": "OBS",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassObservation"
}
},
{
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"representation": [
"xmlAttr"
],
"requirements": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8549).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"patternCode": "EVN"
},
{
"id": "Observation.negationInd",
"path": "Observation.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "Observation.realmCode",
"path": "Observation.realmCode",
"min": 0,
"max": "*",
"base": {
"path": "Observation.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id": "Observation.typeId",
"path": "Observation.typeId",
"min": 0,
"max": "1",
"base": {
"path": "Observation.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "Observation.templateId",
"path": "Observation.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "extension"
},
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"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",
"min": 0,
"max": "*",
"base": {
"path": "Observation.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "Observation.templateId:primary",
"path": "Observation.templateId",
"sliceName": "primary",
"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",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:1198-8550) such that it",
"min": 1,
"max": "1",
"base": {
"path": "Observation.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "Observation.templateId:primary.nullFlavor",
"path": "Observation.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id": "Observation.templateId:primary.assigningAuthorityName",
"path": "Observation.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.templateId:primary.displayable",
"path": "Observation.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "Observation.templateId:primary.root",
"path": "Observation.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.38\" (CONF:1198-10526).",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2.16.840.1.113883.10.20.22.4.38"
},
{
"id": "Observation.templateId:primary.extension",
"path": "Observation.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"requirements": "SHALL contain exactly one [1..1] @extension=\"2015-08-01\" (CONF:1198-32495).",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2015-08-01"
},
{
"id": "Observation.id",
"path": "Observation.id",
"requirements": "SHALL contain at least one [1..*] id (CONF:1198-8551).",
"min": 1,
"max": "*",
"base": {
"path": "Observation.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "Observation.code",
"path": "Observation.code",
"representation": [
"typeAttr"
],
"requirements": "SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Social History Type urn:oid:2.16.840.1.113883.3.88.12.80.60 DYNAMIC (CONF:1198-8558).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
],
"constraint": [
{
"key": "1198-32951",
"severity": "error",
"human": "If @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32951)."
}
],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60"
}
},
{
"id": "Observation.derivationExpr",
"path": "Observation.derivationExpr",
"min": 0,
"max": "1",
"base": {
"path": "Observation.derivationExpr",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ST"
}
]
},
{
"id": "Observation.text",
"path": "Observation.text",
"representation": [
"typeAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id": "Observation.statusCode",
"path": "Observation.statusCode",
"requirements": "SHALL contain exactly one [1..1] statusCode (CONF:1198-8553).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.statusCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id": "Observation.statusCode.nullFlavor",
"path": "Observation.statusCode.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id": "Observation.statusCode.code",
"path": "Observation.statusCode.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"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.",
"requirements": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19117).",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "completed"
},
{
"id": "Observation.statusCode.codeSystem",
"path": "Observation.statusCode.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.codeSystemName",
"path": "Observation.statusCode.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.codeSystemVersion",
"path": "Observation.statusCode.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.displayName",
"path": "Observation.statusCode.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "0",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "valueSet"
}
],
"path": "Observation.statusCode.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "valueSetVersion"
}
],
"path": "Observation.statusCode.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"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.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.statusCode.originalText",
"path": "Observation.statusCode.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "0",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id": "Observation.statusCode.qualifier",
"path": "Observation.statusCode.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CR"
}
]
},
{
"id": "Observation.statusCode.translation",
"path": "Observation.statusCode.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "0",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id": "Observation.effectiveTime",
"path": "Observation.effectiveTime",
"requirements": "SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31868).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.effectiveTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
}
]
},
{
"id": "Observation.priorityCode",
"path": "Observation.priorityCode",
"min": 0,
"max": "1",
"base": {
"path": "Observation.priorityCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id": "Observation.repeatNumber",
"path": "Observation.repeatNumber",
"min": 0,
"max": "1",
"base": {
"path": "Observation.repeatNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/IVL-INT"
}
]
},
{
"id": "Observation.languageCode",
"path": "Observation.languageCode",
"min": 0,
"max": "1",
"base": {
"path": "Observation.languageCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-HumanLanguage"
}
},
{
"id": "Observation.value",
"path": "Observation.value",
"representation": [
"typeAttr"
],
"requirements": "SHOULD contain zero or one [0..1] value (CONF:1198-8559).",
"min": 0,
"max": "1",
"base": {
"path": "Observation.value",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/BL"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ST"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CV"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/SC"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/TEL"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/AD"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/EN"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/INT"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/REAL"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/PQ"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/MO"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/TS"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
},
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ"
}
],
"constraint": [
{
"key": "1198-8555",
"severity": "error",
"human": "If Observation/value is a physical quantity (xsi:type=\"PQ\"), the unit of measure **SHALL** be selected from ValueSet UnitsOfMeasureCaseSensitive (2.16.840.1.113883.1.11.12839) *DYNAMIC* (CONF:1198-8555)."
}
]
},
{
"id": "Observation.interpretationCode",
"path": "Observation.interpretationCode",
"min": 0,
"max": "*",
"base": {
"path": "Observation.interpretationCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationInterpretation"
}
},
{
"id": "Observation.methodCode",
"path": "Observation.methodCode",
"min": 0,
"max": "*",
"base": {
"path": "Observation.methodCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationMethod"
}
},
{
"id": "Observation.targetSiteCode",
"path": "Observation.targetSiteCode",
"definition": "Drawn from concept domain ActSite",
"min": 0,
"max": "*",
"base": {
"path": "Observation.targetSiteCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id": "Observation.subject",
"path": "Observation.subject",
"min": 0,
"max": "1",
"base": {
"path": "Observation.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Element"
}
]
},
{
"id": "Observation.subject.typeCode",
"path": "Observation.subject.typeCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.subject.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "SBJ",
"fixedCode": "SBJ",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject"
}
},
{
"id": "Observation.subject.contextControlCode",
"path": "Observation.subject.contextControlCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.subject.contextControlCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "OP",
"fixedCode": "OP",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id": "Observation.subject.awarenessCode",
"path": "Observation.subject.awarenessCode",
"min": 0,
"max": "1",
"base": {
"path": "Observation.subject.awarenessCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-TargetAwareness"
}
},
{
"id": "Observation.subject.relatedSubject",
"path": "Observation.subject.relatedSubject",
"min": 1,
"max": "1",
"base": {
"path": "Observation.subject.relatedSubject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject"
}
]
},
{
"id": "Observation.specimen",
"path": "Observation.specimen",
"min": 0,
"max": "*",
"base": {
"path": "Observation.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Specimen"
}
]
},
{
"id": "Observation.performer",
"path": "Observation.performer",
"min": 0,
"max": "*",
"base": {
"path": "Observation.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Performer2"
}
]
},
{
"id": "Observation.author",
"path": "Observation.author",
"requirements": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31869).",
"min": 0,
"max": "*",
"base": {
"path": "Observation.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Author",
"profile": [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.119"
]
}
],
"isModifier": false
},
{
"id": "Observation.informant",
"path": "Observation.informant",
"min": 0,
"max": "*",
"base": {
"path": "Observation.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Element"
}
]
},
{
"id": "Observation.informant.typeCode",
"path": "Observation.informant.typeCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.informant.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "INF",
"fixedCode": "INF",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationInformationGenerator"
}
},
{
"id": "Observation.informant.contextControlCode",
"path": "Observation.informant.contextControlCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.informant.contextControlCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "OP",
"fixedCode": "OP",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id": "Observation.informant.assignedEntity",
"path": "Observation.informant.assignedEntity",
"min": 0,
"max": "1",
"base": {
"path": "Observation.informant.assignedEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id": "Observation.informant.relatedEntity",
"path": "Observation.informant.relatedEntity",
"min": 0,
"max": "1",
"base": {
"path": "Observation.informant.relatedEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"
}
]
},
{
"id": "Observation.participant",
"path": "Observation.participant",
"min": 0,
"max": "*",
"base": {
"path": "Observation.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Participant2"
}
]
},
{
"id": "Observation.entryRelationship",
"path": "Observation.entryRelationship",
"min": 0,
"max": "*",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Element"
}
],
"constraint": [
{
"key": "obs-er-1",
"severity": "error",
"human": "Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act",
"expression": "(observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1",
"source": "http://hl7.org/fhir/cda/StructureDefinition/Observation"
}
]
},
{
"id": "Observation.entryRelationship.typeCode",
"path": "Observation.entryRelationship.typeCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.entryRelationship.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Observation.entryRelationship.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.inversionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "Observation.entryRelationship.contextConductionInd",
"path": "Observation.entryRelationship.contextConductionInd",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.entryRelationship.contextConductionInd",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true
},
{
"id": "Observation.entryRelationship.sequenceNumber",
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
]
},
{
"id": "Observation.entryRelationship.negationInd",
"path": "Observation.entryRelationship.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "Observation.entryRelationship.seperatableInd",
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id": "Observation.entryRelationship.observation",
"path": "Observation.entryRelationship.observation",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.observation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Observation"
}
]
},
{
"id": "Observation.entryRelationship.regionOfInterest",
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest"
}
]
},
{
"id": "Observation.entryRelationship.observationMedia",
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia"
}
]
},
{
"id": "Observation.entryRelationship.substanceAdministration",
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "Observation.entryRelationship.supply",
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Supply"
}
]
},
{
"id": "Observation.entryRelationship.procedure",
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Procedure"
}
]
},
{
"id": "Observation.entryRelationship.encounter",
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Encounter"
}
]
},
{
"id": "Observation.entryRelationship.organizer",
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Organizer"
}
]
},
{
"id": "Observation.entryRelationship.act",
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Act"
}
]
},
{
"id": "Observation.reference",
"path": "Observation.reference",
"min": 0,
"max": "*",
"base": {
"path": "Observation.reference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Element"
}
]
},
{
"id": "Observation.reference.typeCode",
"path": "Observation.reference.typeCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.reference.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Observation.reference.seperatableInd",
"path": "Observation.reference.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "Observation.reference.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id": "Observation.reference.externalAct",
"path": "Observation.reference.externalAct",
"min": 0,
"max": "1",
"base": {
"path": "Observation.reference.externalAct",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ExternalAct"
}
]
},
{
"id": "Observation.reference.externalObservation",
"path": "Observation.reference.externalObservation",
"min": 0,
"max": "1",
"base": {
"path": "Observation.reference.externalObservation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation"
}
]
},
{
"id": "Observation.reference.externalProcedure",
"path": "Observation.reference.externalProcedure",
"min": 0,
"max": "1",
"base": {
"path": "Observation.reference.externalProcedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure"
}
]
},
{
"id": "Observation.reference.externalDocument",
"path": "Observation.reference.externalDocument",
"min": 0,
"max": "1",
"base": {
"path": "Observation.reference.externalDocument",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument"
}
]
},
{
"id": "Observation.precondition",
"path": "Observation.precondition",
"min": 0,
"max": "*",
"base": {
"path": "Observation.precondition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Precondition"
}
]
},
{
"id": "Observation.referenceRange",
"path": "Observation.referenceRange",
"min": 0,
"max": "*",
"base": {
"path": "Observation.referenceRange",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Element"
}
]
},
{
"id": "Observation.referenceRange.typeCode",
"path": "Observation.referenceRange.typeCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "Observation.referenceRange.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "REFV",
"fixedCode": "REFV",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActRelationshipPertains"
}
},
{
"id": "Observation.referenceRange.observationRange",
"path": "Observation.referenceRange.observationRange",
"min": 1,
"max": "1",
"base": {
"path": "Observation.referenceRange.observationRange",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ObservationRange"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Observation",
"path": "Observation"
},
{
"id": "Observation.classCode",
"path": "Observation.classCode",
"requirements": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8548).",
"min": 1,
"max": "1",
"patternCode": "OBS"
},
{
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"requirements": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8549).",
"min": 1,
"max": "1",
"patternCode": "EVN"
},
{
"id": "Observation.templateId",
"path": "Observation.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "extension"
},
{
"type": "value",
"path": "root"
}
],
"rules": "open"
}
},
{
"id": "Observation.templateId:primary",
"path": "Observation.templateId",
"sliceName": "primary",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:1198-8550) such that it",
"min": 1,
"max": "1"
},
{
"id": "Observation.templateId:primary.root",
"path": "Observation.templateId.root",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.38\" (CONF:1198-10526).",
"min": 1,
"max": "1",
"patternString": "2.16.840.1.113883.10.20.22.4.38"
},
{
"id": "Observation.templateId:primary.extension",
"path": "Observation.templateId.extension",
"requirements": "SHALL contain exactly one [1..1] @extension=\"2015-08-01\" (CONF:1198-32495).",
"min": 1,
"max": "1",
"patternString": "2015-08-01"
},
{
"id": "Observation.id",
"path": "Observation.id",
"requirements": "SHALL contain at least one [1..*] id (CONF:1198-8551).",
"min": 1,
"max": "*"
},
{
"id": "Observation.code",
"path": "Observation.code",
"requirements": "SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Social History Type urn:oid:2.16.840.1.113883.3.88.12.80.60 DYNAMIC (CONF:1198-8558).",
"min": 1,
"max": "1",
"constraint": [
{
"key": "1198-32951",
"severity": "error",
"human": "If @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32951)."
}
],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60"
}
},
{
"id": "Observation.statusCode",
"path": "Observation.statusCode",
"requirements": "SHALL contain exactly one [1..1] statusCode (CONF:1198-8553).",
"min": 1,
"max": "1"
},
{
"id": "Observation.statusCode.code",
"path": "Observation.statusCode.code",
"requirements": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19117).",
"min": 1,
"max": "1",
"patternString": "completed"
},
{
"id": "Observation.effectiveTime",
"path": "Observation.effectiveTime",
"requirements": "SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31868).",
"min": 1,
"max": "1"
},
{
"id": "Observation.value",
"path": "Observation.value",
"requirements": "SHOULD contain zero or one [0..1] value (CONF:1198-8559).",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1198-8555",
"severity": "error",
"human": "If Observation/value is a physical quantity (xsi:type=\"PQ\"), the unit of measure **SHALL** be selected from ValueSet UnitsOfMeasureCaseSensitive (2.16.840.1.113883.1.11.12839) *DYNAMIC* (CONF:1198-8555)."
}
]
},
{
"id": "Observation.author",
"path": "Observation.author",
"requirements": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31869).",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Author",
"profile": [
"http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.119"
]
}
]
}
]
}
}
FHIR