This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
JSON Format: StructureDefinition-coding-uv-ips
Raw json
{ "resourceType" : "StructureDefinition", "id" : "coding-uv-ips", "meta" : { "lastUpdated" : "2018-03-08T22:39:56.523+11:00" }, "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/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/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/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/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/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/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-coding-uv-ips-definitions.html#Coding" title="null">Coding</a><a name="Coding"> </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"/><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"/></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_bck11.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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-coding-uv-ips-definitions.html#Coding.display" title="null">display</a><a name="Coding.display"> </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"/><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"/></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_bck104.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_complex.png" alt="." style="background-color: white; background-color: inherit" title="Complex Extension" class="hierarchy"/> <a href="StructureDefinition-coding-uv-ips-definitions.html#Coding.display.extension:translation" title="Extension URL = http://hl7.org/fhir/StructureDefinition/translation">translation</a><a name="Coding.display.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">0..*</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">(Complex)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Language Translation (Localization)<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/extension-translation.html">http://hl7.org/fhir/StructureDefinition/translation</a></td></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_bck00.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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <span style="text-decoration:line-through" title="null">userSelected</span><a name="Coding.userSelected"> </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="text-decoration:line-through"/><span style="text-decoration:line-through"></span><span style="text-decoration:line-through">..</span><span style="text-decoration:line-through">0</span></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"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>" }, "url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips", "version" : "0.1.0", "name" : "coding-uv-ips", "title" : "coding with translations", "status" : "draft", "date" : "2018-03-08T22:36:59+11:00", "description" : "This profile extends the capabilities of the coding data type to support multi-language designations (display). It relies oon the Translation extension.", "jurisdiction" : [ { "coding" : [ { "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" } ] } ], "fhirVersion" : "3.0.1", "kind" : "complex-type", "abstract" : false, "type" : "Coding", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Coding", "derivation" : "constraint", "snapshot" : { "element" : [ { "id" : "Coding", "path" : "Coding", "short" : "A reference to a code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "comment" : "Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.", "min" : 0, "max" : "*", "base" : { "path" : "Element", "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity" : "rim", "map" : "CV" }, { "identity" : "orim", "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] }, { "id" : "Coding.id", "path" : "Coding.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Coding.extension", "path" : "Coding.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "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 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.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Coding.system", "path" : "Coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [ { "code" : "uri" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id" : "Coding.version", "path" : "Coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id" : "Coding.code", "path" : "Coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to refer to a particular code in the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [ { "code" : "code" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id" : "Coding.display", "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true } ], "path" : "Coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id" : "Coding.display.id", "path" : "Coding.display.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.", "comment" : "Note that FHIR strings may not exceed 1MB in size", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "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" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Coding.display.extension", "path" : "Coding.display.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "description" : "Extensions are always sliced by (at least) url", "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 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.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "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" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Coding.display.extension:translation", "path" : "Coding.display.extension", "sliceName" : "translation", "short" : "Language Translation (Localization)", "definition" : "Language translation from base language of resource to another language.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension", "profile" : "http://hl7.org/fhir/StructureDefinition/translation" } ], "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" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "rim", "map" : "N/A" }, { "identity" : "rim", "map" : "ST.translation" } ] }, { "id" : "Coding.display.value", "path" : "Coding.display.value", "representation" : [ "xmlAttr" ], "short" : "Primitive value for string", "definition" : "Primitive value for string", "min" : 0, "max" : "1", "base" : { "path" : "string.value", "min" : 0, "max" : "1" }, "maxLength" : 1048576 }, { "id" : "Coding.userSelected", "path" : "Coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "0", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [ { "code" : "boolean" } ], "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" } ], "isSummary" : true, "mapping" : [ { "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" } ] } ] }, "differential" : { "element" : [ { "id" : "Coding", "path" : "Coding" }, { "id" : "Coding.display", "path" : "Coding.display" }, { "id" : "Coding.display.extension", "path" : "Coding.display.extension", "slicing" : { "discriminator" : [ { "type" : "value", "path" : "url" } ], "rules" : "open" } }, { "id" : "Coding.display.extension:translation", "path" : "Coding.display.extension", "sliceName" : "translation", "short" : "Language Translation (Localization)", "type" : [ { "code" : "Extension", "profile" : "http://hl7.org/fhir/StructureDefinition/translation" } ] }, { "id" : "Coding.userSelected", "path" : "Coding.userSelected", "max" : "0" } ] } }