INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
JSON representation of the CareConnect-Quantity-1 Profile.
{
"resourceType" : "StructureDefinition",
"id" : "CareConnect-Quantity-1",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CareConnect-Quantity-1-definitions.html#Quantity\">Quantity</a><a name=\"Quantity\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/datatypes.html#Quantity\">Quantity</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck12.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_extension_simple.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Simple Extension\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CareConnect-Quantity-1-definitions.html#Quantity.extension\">extension</a><a name=\"Quantity.extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/STU3/extensibility.html#Extension\">Extension</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Slice: </span>Unordered, Open by value:url</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck04.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CareConnect-Quantity-1-definitions.html#Quantity.extension:valueApproximation\" title=\"Extension URL = https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ValueApproximation-1\">Extension-CareConnect-ValueApproximation-1</a><a name=\"Quantity.extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span>..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/datatypes.html#boolean\">boolean</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Value Approximation<br/><span style=\"font-weight:bold\">URL: </span><a href=\"http://hl7.org/fhir/STU3/StructureDefinition-Extension-CareConnect-ValueApproximation-1.html\">https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ValueApproximation-1</a></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Quantity-1",
"version" : "3.0.0",
"name" : "CareConnect-Quantity-1",
"status" : "draft",
"date" : "2019-04-03",
"publisher" : "INTEROpen",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "https://interopen.ryver.com/"
}
]
}
],
"description" : "Enhanced quantity data type that supports an approximation indicator.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "826"
}
]
}
],
"copyright" : "Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html",
"fhirVersion" : "3.0.2",
"mapping" : [
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "complex-type",
"abstract" : false,
"type" : "Quantity",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Quantity",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Quantity",
"path" : "Quantity",
"short" : "A measured or measurable amount",
"definition" : "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.",
"comment" : "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Quantity",
"min" : 0,
"max" : "*"
},
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "qty-3",
"severity" : "error",
"human" : "If a code for the unit is present, the system SHALL also be present",
"expression" : "code.empty() or system.exists()",
"xpath" : "not(exists(f:code)) or exists(f:system)",
"source" : "http://hl7.org/fhir/StructureDefinition/Quantity"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "SN (see also Range) or CQ"
},
{
"identity" : "rim",
"map" : "PQ, IVL<PQ>, MO, CO, depending on the values"
}
]
},
{
"id" : "Quantity.id",
"path" : "Quantity.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Quantity.extension",
"path" : "Quantity.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Quantity.extension:valueApproximation",
"path" : "Quantity.extension",
"sliceName" : "valueApproximation",
"short" : "Value Approximation",
"definition" : "Value Approximation",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ValueApproximation-1"
}
]
},
{
"id" : "Quantity.value",
"path" : "Quantity.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.",
"comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"requirements" : "Precision is handled implicitly in almost all cases of measurement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"isSummary" : true,
"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"
}
]
},
{
"id" : "Quantity.comparator",
"path" : "Quantity.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.",
"comment" : "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the 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,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuantityComparator"
}
],
"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"
}
]
},
{
"id" : "Quantity.unit",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Quantity.unit",
"short" : "Unit representation",
"definition" : "A human-readable form of the unit.",
"requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.unit",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.unit"
}
]
},
{
"id" : "Quantity.system",
"path" : "Quantity.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" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"qty-3"
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "CO.codeSystem, PQ.translation.codeSystem"
}
]
},
{
"id" : "Quantity.code",
"path" : "Quantity.code",
"short" : "Coded form of the unit",
"definition" : "A computer processable form of the unit in some unit representation system.",
"comment" : "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.code, MO.currency, PQ.translation.code"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Quantity",
"path" : "Quantity"
},
{
"id" : "Quantity.extension",
"path" : "Quantity.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "Quantity.extension:valueApproximation",
"path" : "Quantity.extension",
"sliceName" : "valueApproximation",
"short" : "Value Approximation",
"definition" : "Value Approximation",
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ValueApproximation-1"
}
]
}
]
}
}