{ "resourceType": "StructureDefinition", "id": "spark896", "meta": { "versionId": "spark935", "lastUpdated": "2015-10-02T14:45:59.576+00:00" }, "url": "http://hl7.org/fhir/StructureDefinition/CollagenCrosslinkedNMinusTelopeptideCreatinineScRtoPtUrineQnLabObs", "name": "HSPC StdQtyObs Collagen crosslinked N-telopeptide/Creatinine", "status": "draft", "publisher": "HSPC", "contact": [ { "telecom": [ { "system": "other", "value": "http://healthcaresoa.org" } ] } ], "date": "2015-02-18", "description": "??", "kind": "resource", "constrainedType": "Observation", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/hspc-stdqty", "snapshot": { "element": [ { "path": "Observation", "name": "hspc-stdqty", "short": "Measurements and simple assertions", "definition": "Measurements and simple assertions made about a patient, device or other subject.", "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "min": 0, "max": "*", "base": { "path": "Observation", "min": 0, "max": "*" }, "type": [ { "code": "Observation" } ], "constraint": [ { "key": "obs-6", "severity": "error", "human": "Shall only be present if Observation.value[x] is not present", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "key": "obs-7", "severity": "error", "human": "Component code Shall not be same as observation code", "xpath": "not(exists(f:component.code/@value)) or (f:code/@value != f:component/f:code/@value)" }, { "key": "inv-1", "severity": "error", "human": "Must have either a value or a dataAbsentReason but not both", "xpath": "(f:value or f:dataAbsentReason) and (not(f:value and f:dataAbsentReason))" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical" } ] }, { "path": "Observation.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes.", "min": 0, "max": "1", "base": { "path": "Observation.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "path": "Observation.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Observation.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "min": 0, "max": "1", "base": { "path": "Observation.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "Observation.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "min": 0, "max": "1", "base": { "path": "Observation.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "Observation.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "Observation.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "Observation.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.extension", "name": "reportingPriority", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority" ] } ] }, { "path": "Observation.extension", "name": "deltaFlag", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-delta-flag" ] } ] }, { "path": "Observation.extension", "name": "verified", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-verified" ] } ] }, { "path": "Observation.extension", "name": "updated", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-updated" ] } ] }, { "path": "Observation.extension", "name": "focal-subject", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Observation.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/observation-focal-subject" ] } ] }, { "path": "Observation.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Observation.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.identifier", "short": "Unique Id for this particular observation", "definition": "A unique identifier for the simple observation instance.", "requirements": "Allows observations to be distinguished and referenced.", "min": 0, "max": "0", "base": { "path": "Observation.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "v2", "map": "OBX.21" }, { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "path": "Observation.status", "short": "registered | preliminary | final | amended +", "definition": "The status of the result value.", "requirements": "Need to track the status of individual results - some results are finalised before the whole report is finalised.", "min": 1, "max": "1", "base": { "path": "Observation.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Codes providing the status of an observation", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-status" } }, "mapping": [ { "identity": "v2", "map": "OBX-11-observation result status" }, { "identity": "rim", "map": "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\"" }, { "identity": "w5", "map": "status" } ] }, { "path": "Observation.category", "short": "Classification of type of observation", "definition": "A code that classifies the the general type of observation being made. This is used for searching, sorting and display purposes.", "min": 0, "max": "1", "base": { "path": "Observation.category", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes for high level observation categories", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-category" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] }, { "path": "Observation.code", "short": "Type of observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"name\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "base": { "path": "Observation.code", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "fixedCodeableConcept": { "coding": [ { "system": "http://loinc.org/", "code": "14115-0" } ] }, "isSummary": true, "binding": { "strength": "preferred", "description": "Standard LOINC codes", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-QuantitativeLabCodes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3-observation identifier" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" }, { "identity": "cdl.key", "map": "StandardLabObs_KEY_VALUESET_ECID" } ] }, { "path": "Observation.subject", "short": "Who and/or what this is about", "definition": "The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.", "requirements": "Observations have no value if you don't know who or what they're about.", "min": 1, "max": "1", "base": { "path": "Observation.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3-patient ID list" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "who.focus" }, { "identity": "cdl.key", "map": "Subject_KEY_ECID" } ] }, { "path": "Observation.encounter", "short": "Healthcare event during which this observation is made", "definition": "The healthcare event ( e.g. a patient and healthcare provider interaction ) during which this observation is made.", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "min": 0, "max": "1", "base": { "path": "Observation.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "mapping": [ { "identity": "v2", "map": "PV1" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "path": "Observation.effective[x]", "short": "Clinically Relevant time/time-period for observation", "definition": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "min": 0, "max": "1", "base": { "path": "Observation.effective[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)" }, { "identity": "rim", "map": "effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Observation.issued", "short": "Date/Time this was made available", "definition": "The date and time this observation was made available to providers, typically after the results have been reviewed and verified.", "min": 0, "max": "1", "base": { "path": "Observation.issued", "min": 0, "max": "1" }, "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)" }, { "identity": "rim", "map": "participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "path": "Observation.performer", "slicing": { "discriminator": [ "performer.type" ], "ordered": true, "rules": "closed" }, "short": "Who is responsible for the observation", "definition": "Who was responsible for asserting the observed value as \"true\".", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "*", "base": { "path": "Observation.performer", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / (Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'" }, { "identity": "rim", "map": "participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" } ] }, { "path": "Observation.performer", "name": "person", "short": "the individual with the primary responsibility for the procedure or action being taken", "definition": "the individual with the primary responsibility for the procedure or action being taken.", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "*", "base": { "path": "Observation.performer", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-responsibleobserver" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / (Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'" }, { "identity": "rim", "map": "participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" }, { "identity": "cdl.key", "map": "ResponsibleObserver_KEY_ECID" } ] }, { "path": "Observation.performer", "name": "lab", "short": "name and address of the laboratory that performs the test", "definition": "documents the name and address of the laboratory that performs the test. This is a CLIA required item to be printed on the report, CLIA requires the name of the laboratory, city and state of the laboratory.", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "1", "base": { "path": "Observation.performer", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-performinglaboratory" ] } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / (Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'" }, { "identity": "rim", "map": "participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.actor" }, { "identity": "cdl.key", "map": "PerformingLaboratory_KEY_ECID" } ] }, { "path": "Observation.valueQuantity", "short": "Actual result", "definition": "The information determined as a result of making the observation, if the information has a simple value.", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "base": { "path": "Observation.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.valueQuantity.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Quantity.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.valueQuantity.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Quantity.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.valueQuantity.value", "short": "Numerical value (with implicit precision)", "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "min": 1, "max": "1", "base": { "path": "Quantity.value", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ] }, { "path": "Observation.valueQuantity.comparator", "short": "< | <= | >= | > - how to understand the value", "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is \"<\" , then the real value is < stated value.", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "min": 0, "max": "1", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "isModifier": true, "binding": { "strength": "required", "description": "How the Quantity should be understood and represented", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/quantity-comparator" } }, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ] }, { "path": "Observation.valueQuantity.unit", "short": "Unit representation", "definition": "A human-readable form of the units.", "requirements": "There are many representations for units and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "min": 1, "max": "1", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "path": "Observation.valueQuantity.system", "short": "System that defines coded unit form", "definition": "The identification of the system that provides the coded form of the unit.", "requirements": "Need to know the system that defines the coded form of the unit.", "min": 1, "max": "1", "base": { "path": "Quantity.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://unitsofmeasure.org/", "condition": [ "qty-3" ], "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ] }, { "path": "Observation.valueQuantity.code", "short": "Coded form of the unit", "definition": "A computer processable form of the units in some unit representation system.", "requirements": "Need a computable form of the units that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "min": 1, "max": "1", "base": { "path": "Quantity.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ] }, { "path": "Observation.dataAbsentReason", "short": "Why the result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "base": { "path": "Observation.dataAbsentReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.interpretation", "short": "High, low, normal, etc.", "definition": "The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "alias": [ "Abnormal Flag" ], "min": 0, "max": "1", "base": { "path": "Observation.interpretation", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "The set of codes that describe in what way a lab value is abnormal", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-abnInt-NumericNom" } }, "mapping": [ { "identity": "v2", "map": "OBX-8-interpretation codes" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "cdl.key", "map": "AbnormalInterpretation_KEY_ECID,OrdinalInterpretation_KEY_ECID" } ] }, { "path": "Observation.comments", "short": "Comments about result", "definition": "May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.", "requirements": "Need to be able to provide free text additional information.", "min": 0, "max": "1", "base": { "path": "Observation.comments", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)" }, { "identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value" }, { "identity": "cdl.key", "map": "Comment_KEY_ECID" } ] }, { "path": "Observation.bodySite", "short": "Observed body part", "definition": "Indicates the site on the subject's body where the observation was made ( i.e. the target site).", "requirements": "Knowing where the observation is made is important for tracking if multiple sites are possible.", "min": 0, "max": "0", "base": { "path": "Observation.bodySite", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Codes describing anatomical locations. May include laterality", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/body-site" } }, "mapping": [ { "identity": "v2", "map": "OBX-20-observation site" }, { "identity": "rim", "map": "targetSiteCode" } ] }, { "path": "Observation.method", "short": "How it was done", "definition": "Indicates the mechanism used to perform the observation.", "requirements": "In some cases, method can impact results and is thus for determining whether results can be compared or determining significance of results.", "min": 0, "max": "0", "base": { "path": "Observation.method", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Methods for simple observations", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-methods" } }, "mapping": [ { "identity": "v2", "map": "OBX-17-observation method" }, { "identity": "rim", "map": "methodCode" } ] }, { "path": "Observation.specimen", "short": "Specimen used for this observation", "definition": "The specimen that was used when this observation was made.", "min": 0, "max": "1", "base": { "path": "Observation.specimen", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-specimen" ], "aggregation": [ "contained" ] } ], "mapping": [ { "identity": "v2", "map": "SPM segment" }, { "identity": "rim", "map": "participation[typeCode=SPC].specimen" } ] }, { "path": "Observation.device", "short": "(Measurement) Device", "definition": "The device used to generate the observation data.", "min": 0, "max": "1", "base": { "path": "Observation.device", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ], "mapping": [ { "identity": "v2", "map": "OBX-17 / PRT -10" }, { "identity": "rim", "map": "participation[typeCode=DEV]" } ] }, { "path": "Observation.referenceRange", "short": "Provides guide for interpretation", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 1, "max": "1", "base": { "path": "Observation.referenceRange", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "obs-3", "severity": "error", "human": "Must have at least a low or a high or text", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Observation.referenceRange.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.referenceRange.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Observation.referenceRange.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.referenceRange.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "Observation.referenceRange.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "definition": "The value of the low bound of the reference range. If this element is omitted, the low bound of the reference range is assumed to be meaningless. (e.g. reference range is <2.3) If the low.comparator element is missing, it is assumed to be '>'.", "min": 0, "max": "0", "base": { "path": "Observation.referenceRange.low", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3", "obs-4" ], "constraint": [ { "key": "obs-4", "severity": "error", "human": "Low range comparators can only be '>' or '>=' or empty", "xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<=')" } ], "mapping": [ { "identity": "v2", "map": "OBX-7-references range" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ] }, { "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "definition": "The value of the high bound of the reference range. If this element is omitted, the high bound of the reference range is assumed to be meaningless. (e.g. reference range is > 5) If the low.comparator element is missing , it is assumed to be '<'.", "min": 0, "max": "0", "base": { "path": "Observation.referenceRange.high", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "condition": [ "obs-3", "obs-5" ], "constraint": [ { "key": "obs-5", "severity": "error", "human": "High range comparators can only be '<' or '<=' or empty", "xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>=')" } ], "mapping": [ { "identity": "v2", "map": "OBX-7-references range" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ] }, { "path": "Observation.referenceRange.meaning", "short": "Indicates the meaning/use of this range of this range", "definition": "Code for the meaning of the reference range.", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).", "min": 0, "max": "0", "base": { "path": "Observation.referenceRange.meaning", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "description": "Code for the meaning of a reference range", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/referencerange-meaning" } }, "mapping": [ { "identity": "v2", "map": "OBX-10-nature of abnormal test?" }, { "identity": "rim", "map": "interpretationCode" } ] }, { "path": "Observation.referenceRange.age", "short": "Applicable age range, if relevant", "definition": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", "requirements": "Some analytes vary greatly over age.", "min": 0, "max": "0", "base": { "path": "Observation.referenceRange.age", "min": 0, "max": "1" }, "type": [ { "code": "Range" } ], "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ] }, { "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of 'normals'.", "min": 1, "max": "1", "base": { "path": "Observation.referenceRange.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "OBX-7-references range" }, { "identity": "rim", "map": "value:ST" } ] }, { "path": "Observation.related", "short": "Resource related to this observation", "definition": "A reference to another resource ( usally another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.", "requirements": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and a set of related observations or sometimes QuestionnaireResponse from which the measure is derived.", "min": 0, "max": "0", "base": { "path": "Observation.related", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ] }, { "path": "Observation.related.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Observation.related.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.related.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Observation.related.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.related.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "Observation.related.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.related.type", "short": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by", "definition": "A code specifying the kind of relationship that exists with the target resource.", "requirements": "A relationship type SHOULD be provided.", "min": 0, "max": "1", "base": { "path": "Observation.related.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "Codes specifying how two observations are related", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-relationshiptypes" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": ".typeCode" } ] }, { "path": "Observation.related.target", "short": "Resource that is related to this one", "definition": "A reference to the observation or questionnaireanswer that is related to this observation.", "min": 1, "max": "1", "base": { "path": "Observation.related.target", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" ] } ], "mapping": [ { "identity": "rim", "map": ".targetObservation" } ] }, { "path": "Observation.component", "short": "Component results", "definition": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for for genetics observations.", "requirements": "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation ( they are not seperable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", "min": 0, "max": "*", "base": { "path": "Observation.component", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ] }, { "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Observation.component.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.component.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Observation.component.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Observation.component.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "Observation.component.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Observation.component.code", "short": "Type of component observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "base": { "path": "Observation.component.code", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-7" ], "isSummary": true, "binding": { "strength": "example", "description": "Codes identifying names of simple observations", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-codes" } }, "mapping": [ { "identity": "v2", "map": "OBX-3-observation identifier" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "path": "Observation.component.value[x]", "short": "Actual component result", "definition": "The information determined as a result of making the observation, if the information has a simple value.", "requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.", "min": 0, "max": "1", "base": { "path": "Observation.component.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Attachment" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX.2, OBX.5, OBX.6" }, { "identity": "rim", "map": "value" } ] }, { "path": "Observation.component.dataAbsentReason", "short": "Why the component result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "base": { "path": "Observation.component.dataAbsentReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "obs-6" ], "binding": { "strength": "extensible", "description": "Codes specifying why the result (Observation.value[x]) is missing", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/observation-valueabsentreason" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ] }, { "path": "Observation.component.referenceRange", "short": "Provides guide for interpretation ofcomponent result", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "base": { "path": "Observation.component.referenceRange", "min": 0, "max": "*" }, "nameReference": "referenceRange", "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ] } ] }, "differential": { "element": [ { "path": "Observation.code", "fixedCodeableConcept": { "coding": [ { "system": "http://loinc.org/", "code": "14115-0" } ] } }, { "path": "Observation.valueQuantity.code", "min": 1, "max": "1" } ] } }