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 
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="oncology-DistanceToNipple-model"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p><b>BC DistanceToNipple Logical Model</b></p> <p>The body site location in relation to the nipple.</p> </div> </text> <url value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-DistanceToNipple-model"/> <identifier> <system value="http://hl7.org/fhir/us/breastcancer"/> <value value="oncology.DistanceToNipple"/> </identifier> <version value="0.1.0"/> <name value="DistanceToNippleModel"/> <title value="BC DistanceToNipple Logical Model"/> <status value="draft"/> <date value="2018-04-01T00:00:00+11:00"/> <publisher value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/> <contact> <telecom> <system value="url"/> <value value="http://standardhealthrecord.org"/> </telecom> </contact> <description value="The body site location in relation to the nipple."/> <kind value="logical"/> <abstract value="false"/> <type value="oncology-DistanceToNipple-model"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/> <derivation value="specialization"/> <snapshot> <element id="oncology-DistanceToNipple-model"> <path value="oncology-DistanceToNipple-model"/> <definition value="The body site location in relation to the nipple."/> <min value="0"/> <max value="*"/> <base> <path value="oncology-DistanceToNipple-model"/> <min value="0"/> <max value="*"/> </base> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value"> <path value="oncology-DistanceToNipple-model.value"/> <short value="Quantity representing the body site location in relation to the nipple."/> <definition value="Quantity representing the body site location in relation to the nipple."/> <alias value="quantity"/> <min value="1"/> <max value="1"/> <base> <path value="oncology-DistanceToNipple-model.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.value"> <path value="oncology-DistanceToNipple-model.value.value"/> <short value="Decimal representing a quantity with units, whose value may be bounded from above or below, as defined in FHIR."/> <definition value="Decimal representing a quantity with units, whose value may be bounded from above or below, as defined in FHIR. This definition is not fully consistent with CIMI V0.0.4 (whose definition of Quantity lacks a comparator, but includes numerical precision). Complex data types that appear frequently in FHIR have not been profiled, even if CIMI defines them differently. This choice means that the breast cancer profiles use the native FHIR datatype, rather than having to substitute a CIMI profile everywhere the native type is used."/> <alias value="decimal"/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="decimal"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.comparator"> <path value="oncology-DistanceToNipple-model.value.comparator"/> <short value="Comparator"/> <definition value="Comparator"/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.comparator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Comparator-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units"> <path value="oncology-DistanceToNipple-model.value.units"/> <short value="Code for the unit of measure of the quantity."/> <definition value="Code for the unit of measure of the quantity."/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.units"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Units-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units.value"> <path value="oncology-DistanceToNipple-model.value.units.value"/> <code> <system value="http://ncimeta.nci.nih.gov"/> <code value="C0805701"/> </code> <short value="Code representing code for the unit of measure of the quantity."/> <definition value="Code representing code for the unit of measure of the quantity."/> <alias value="coding"/> <min value="1"/> <max value="1"/> <base> <path value="shr-core-Units-model.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units.value.id"> <path value="oncology-DistanceToNipple-model.value.units.value.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.extension"> <path value="oncology-DistanceToNipple-model.value.units.value.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="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 value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.system"> <path value="oncology-DistanceToNipple-model.value.units.value.system"/> <short value="Identity of the terminology system"/> <definition value="The identification of the code system that defines the meaning of the symbol in the code."/> <comment value="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 value="Need to be unambiguous about the source of the definition of the symbol."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://unitsofmeasure.org"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystem"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.version"> <path value="oncology-DistanceToNipple-model.value.units.value.version"/> <short value="Version of the system - if relevant"/> <definition value="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 value="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 value="0"/> <max value="1"/> <base> <path value="Coding.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.7"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystemVersion"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.code"> <path value="oncology-DistanceToNipple-model.value.units.value.code"/> <short value="Symbol in syntax defined by the system"/> <definition value="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 value="Need to refer to a particular code in the system."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <fixedCode value="cm"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="oncology-DistanceToNipple-model.value.units.value.display"/> <short value="Representation defined by the system"/> <definition value="A representation of the meaning of the code in the system, following the rules of the system."/> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.2 - but note this is not well followed"/> </mapping> <mapping> <identity value="rim"/> <map value="CV.displayName"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.userSelected"> <path value="oncology-DistanceToNipple-model.value.units.value.userSelected"/> <short value="If this coding was chosen directly by the user"/> <definition value="Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)."/> <comment value="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 value="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 value="0"/> <max value="1"/> <base> <path value="Coding.userSelected"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Sometimes implied by being first"/> </mapping> <mapping> <identity value="rim"/> <map value="CD.codingRationale"/> </mapping> <mapping> <identity value="orim"/> <map value="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 ]"/> </mapping> </element> </snapshot> <differential> <element id="oncology-DistanceToNipple-model"> <path value="oncology-DistanceToNipple-model"/> <definition value="The body site location in relation to the nipple."/> <min value="0"/> <max value="*"/> <base> <path value="oncology-DistanceToNipple-model"/> <min value="0"/> <max value="*"/> </base> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value"> <path value="oncology-DistanceToNipple-model.value"/> <short value="Quantity representing the body site location in relation to the nipple."/> <definition value="Quantity representing the body site location in relation to the nipple."/> <alias value="quantity"/> <min value="1"/> <max value="1"/> <base> <path value="oncology-DistanceToNipple-model.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.value"> <path value="oncology-DistanceToNipple-model.value.value"/> <short value="Decimal representing a quantity with units, whose value may be bounded from above or below, as defined in FHIR."/> <definition value="Decimal representing a quantity with units, whose value may be bounded from above or below, as defined in FHIR. This definition is not fully consistent with CIMI V0.0.4 (whose definition of Quantity lacks a comparator, but includes numerical precision). Complex data types that appear frequently in FHIR have not been profiled, even if CIMI defines them differently. This choice means that the breast cancer profiles use the native FHIR datatype, rather than having to substitute a CIMI profile everywhere the native type is used."/> <alias value="decimal"/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="decimal"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.comparator"> <path value="oncology-DistanceToNipple-model.value.comparator"/> <short value="Comparator"/> <definition value="Comparator"/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.comparator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Comparator-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units"> <path value="oncology-DistanceToNipple-model.value.units"/> <short value="Code for the unit of measure of the quantity."/> <definition value="Code for the unit of measure of the quantity."/> <min value="0"/> <max value="1"/> <base> <path value="shr-core-Quantity-model.units"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Units-model"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units.value"> <path value="oncology-DistanceToNipple-model.value.units.value"/> <code> <system value="http://ncimeta.nci.nih.gov"/> <code value="C0805701"/> </code> <short value="Code representing code for the unit of measure of the quantity."/> <definition value="Code representing code for the unit of measure of the quantity."/> <alias value="coding"/> <min value="1"/> <max value="1"/> <base> <path value="shr-core-Units-model.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="oncology-DistanceToNipple-model.value.units.value.id"> <path value="oncology-DistanceToNipple-model.value.units.value.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.extension"> <path value="oncology-DistanceToNipple-model.value.units.value.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="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 value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.system"> <path value="oncology-DistanceToNipple-model.value.units.value.system"/> <short value="Identity of the terminology system"/> <definition value="The identification of the code system that defines the meaning of the symbol in the code."/> <comment value="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 value="Need to be unambiguous about the source of the definition of the symbol."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://unitsofmeasure.org"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystem"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.version"> <path value="oncology-DistanceToNipple-model.value.units.value.version"/> <short value="Version of the system - if relevant"/> <definition value="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 value="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 value="0"/> <max value="1"/> <base> <path value="Coding.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.7"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystemVersion"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.code"> <path value="oncology-DistanceToNipple-model.value.units.value.code"/> <short value="Symbol in syntax defined by the system"/> <definition value="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 value="Need to refer to a particular code in the system."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <fixedCode value="cm"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="oncology-DistanceToNipple-model.value.units.value.display"/> <short value="Representation defined by the system"/> <definition value="A representation of the meaning of the code in the system, following the rules of the system."/> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="C*E.2 - but note this is not well followed"/> </mapping> <mapping> <identity value="rim"/> <map value="CV.displayName"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/> </mapping> </element> <element id="oncology-DistanceToNipple-model.value.units.value.userSelected"> <path value="oncology-DistanceToNipple-model.value.units.value.userSelected"/> <short value="If this coding was chosen directly by the user"/> <definition value="Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)."/> <comment value="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 value="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 value="0"/> <max value="1"/> <base> <path value="Coding.userSelected"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Sometimes implied by being first"/> </mapping> <mapping> <identity value="rim"/> <map value="CD.codingRationale"/> </mapping> <mapping> <identity value="orim"/> <map value="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 ]"/> </mapping> </element> </differential> </StructureDefinition>