HL7 FHIR® Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment)
This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.1.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "StructureDefinition",
"id" : "shr-core-Percentage-model",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<p><b>BC Percentage Logical Model</b></p>
<p>A percentage value where 100.0 represents 100%.</p>
</div>"
},
"url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Percentage-model",
"identifier" : [
{
"system" : "http://hl7.org/fhir/us/breastcancer",
"value" : "shr.core.Percentage"
}
],
"version" : "0.1.0",
"name" : "PercentageModel",
"title" : "BC Percentage Logical Model",
"status" : "draft",
"date" : "2018-04-01T00:00:00+11:00",
"publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://standardhealthrecord.org"
}
]
}
],
"description" : "A percentage value where 100.0 represents 100%.",
"keyword" : [
{
"system" : "http://ncimeta.nci.nih.gov",
"code" : "C0439165"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "shr-core-Percentage-model",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "shr-core-Percentage-model",
"path" : "shr-core-Percentage-model",
"definition" : "A percentage value where 100.0 represents 100%.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "shr-core-Percentage-model",
"min" : 0,
"max" : "*"
},
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.value",
"path" : "shr-core-Percentage-model.value",
"short" : "Decimal representing a percentage value where 100.0 represents 100%.",
"definition" : "Decimal representing a percentage value where 100.0 represents 100%.",
"alias" : [
"decimal"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "shr-core-Percentage-model.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.comparator",
"path" : "shr-core-Percentage-model.comparator",
"short" : "Comparator",
"definition" : "Comparator",
"min" : 0,
"max" : "0",
"base" : {
"path" : "shr-core-Percentage-model.comparator",
"min" : 0,
"max" : "0"
},
"type" : [
{
"code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Comparator-model"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units",
"path" : "shr-core-Percentage-model.units",
"short" : "Code for the unit of measure of the quantity.",
"definition" : "Code for the unit of measure of the quantity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "shr-core-Percentage-model.units",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Units-model"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units.value",
"path" : "shr-core-Percentage-model.units.value",
"code" : [
{
"system" : "http://ncimeta.nci.nih.gov",
"code" : "C0805701"
}
],
"short" : "Code representing code for the unit of measure of the quantity.",
"definition" : "Code representing code for the unit of measure of the quantity.",
"alias" : [
"coding"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "shr-core-Units-model.value",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units.value.id",
"path" : "shr-core-Percentage-model.units.value.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" : "shr-core-Percentage-model.units.value.extension",
"path" : "shr-core-Percentage-model.units.value.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"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.system",
"path" : "shr-core-Percentage-model.units.value.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" : 1,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://unitsofmeasure.org",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.version",
"path" : "shr-core-Percentage-model.units.value.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"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.code",
"path" : "shr-core-Percentage-model.units.value.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).",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "%",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "shr-core-Percentage-model.units.value.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.",
"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"
}
],
"isSummary" : true,
"mapping" : [
{
"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" : "shr-core-Percentage-model.units.value.userSelected",
"path" : "shr-core-Percentage-model.units.value.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" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"isSummary" : true,
"mapping" : [
{
"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" : "shr-core-Percentage-model",
"path" : "shr-core-Percentage-model",
"definition" : "A percentage value where 100.0 represents 100%.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "shr-core-Percentage-model",
"min" : 0,
"max" : "*"
},
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.value",
"path" : "shr-core-Percentage-model.value",
"short" : "Decimal representing a percentage value where 100.0 represents 100%.",
"definition" : "Decimal representing a percentage value where 100.0 represents 100%.",
"alias" : [
"decimal"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "shr-core-Percentage-model.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.comparator",
"path" : "shr-core-Percentage-model.comparator",
"short" : "Comparator",
"definition" : "Comparator",
"min" : 0,
"max" : "0",
"base" : {
"path" : "shr-core-Percentage-model.comparator",
"min" : 0,
"max" : "0"
},
"type" : [
{
"code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Comparator-model"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units",
"path" : "shr-core-Percentage-model.units",
"short" : "Code for the unit of measure of the quantity.",
"definition" : "Code for the unit of measure of the quantity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "shr-core-Percentage-model.units",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Units-model"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units.value",
"path" : "shr-core-Percentage-model.units.value",
"code" : [
{
"system" : "http://ncimeta.nci.nih.gov",
"code" : "C0805701"
}
],
"short" : "Code representing code for the unit of measure of the quantity.",
"definition" : "Code representing code for the unit of measure of the quantity.",
"alias" : [
"coding"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "shr-core-Units-model.value",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "shr-core-Percentage-model.units.value.id",
"path" : "shr-core-Percentage-model.units.value.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" : "shr-core-Percentage-model.units.value.extension",
"path" : "shr-core-Percentage-model.units.value.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"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.system",
"path" : "shr-core-Percentage-model.units.value.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" : 1,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://unitsofmeasure.org",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.version",
"path" : "shr-core-Percentage-model.units.value.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"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.code",
"path" : "shr-core-Percentage-model.units.value.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).",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "%",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "shr-core-Percentage-model.units.value.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "shr-core-Percentage-model.units.value.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.",
"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"
}
],
"isSummary" : true,
"mapping" : [
{
"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" : "shr-core-Percentage-model.units.value.userSelected",
"path" : "shr-core-Percentage-model.units.value.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" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"isSummary" : true,
"mapping" : [
{
"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 ]"
}
]
}
]
}
}