HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

SpecimenTreatmentProfile


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-entity-SpecimenTreatment"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC SpecimenTreatment Profile</b></p>
  <p>Treatment performed on the specimen.</p>
  <p><b>BC Mapping Summary</b></p>
  <p><pre>cimi.entity.SpecimenTreatment maps to Basic:
</pre></p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.entity.SpecimenTreatment"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="SpecimenTreatmentProfile"/>
  <title value="BC SpecimenTreatment Profile"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+00:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </telecom>
  </contact>
  <description value="Treatment performed on the specimen."/>
  <purpose
           value="Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources."/>
  <fhirVersion value="3.0.1"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <mapping>
    <identity value="w5"/>
    <uri value="http://hl7.org/fhir/w5"/>
    <name value="W5 Mapping"/>
  </mapping>
  <kind value="resource"/>
  <abstract value="false"/>
  <type value="Basic"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Basic"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Basic:cimi-entity-SpecimenTreatment">
      <path value="Basic"/>
      <short value="BC SpecimenTreatment Profile"/>
      <definition value="Treatment performed on the specimen."/>
      <alias value="Z-resource"/>
      <alias value="Extension-resource"/>
      <alias value="Custom-resource"/>
      <min value="0"/>
      <max value="*"/>
      <constraint>
        <key value="dom-2"/>
        <severity value="error"/>
        <human
               value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
        <expression value="contained.contained.empty()"/>
        <xpath value="not(parent::f:contained and f:contained)"/>
        <source value="DomainResource"/>
      </constraint>
      <constraint>
        <key value="dom-1"/>
        <severity value="error"/>
        <human
               value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/>
        <expression value="contained.text.empty()"/>
        <xpath value="not(parent::f:contained and f:text)"/>
        <source value="DomainResource"/>
      </constraint>
      <constraint>
        <key value="dom-4"/>
        <severity value="error"/>
        <human
               value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
        <expression
                    value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
        <xpath
               value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
        <source value="DomainResource"/>
      </constraint>
      <constraint>
        <key value="dom-3"/>
        <severity value="error"/>
        <human
               value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/>
        <expression
                    value="contained.where((&#39;#&#39;+id in %resource.descendants().reference).not()).empty()"/>
        <xpath
               value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat(&#39;#&#39;, $id))]))"/>
        <source value="DomainResource"/>
      </constraint>
      <mapping>
        <identity value="rim"/>
        <map value="Entity. Role, or Act"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="Act, Entity or Role"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="infrastructure.structure"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.id">
      <path value="Basic.id"/>
      <short value="Logical id of this artifact"/>
      <definition
                  value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
      <comment
               value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.meta">
      <path value="Basic.meta"/>
      <short value="Metadata about the resource"/>
      <definition
                  value="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 value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.meta"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Meta"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.implicitRules">
      <path value="Basic.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition
                  value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/>
      <comment
               value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it&#39;s meaning or interpretation."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.implicitRules"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.language">
      <path value="Basic.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comment
               value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource  Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.language"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
          <valueReference>
            <reference value="http://hl7.org/fhir/ValueSet/all-languages"/>
          </valueReference>
        </extension>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="Language"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true"/>
        </extension>
        <strength value="extensible"/>
        <description value="A human language."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/languages"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.text">
      <path value="Basic.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition
                  value="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 &quot;clinically safe&quot; for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/>
      <comment
               value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a &quot;text blob&quot; or where text is additionally entered raw or narrated and encoded in formation is added later."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DomainResource.text"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.contained">
      <path value="Basic.contained"/>
      <short value="Contained, inline Resources"/>
      <definition
                  value="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."/>
      <comment
               value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DomainResource.contained"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.extension">
      <path value="Basic.extension"/>
      <slicing id="1">
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <ordered value="false"/>
        <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 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."/>
      <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="DomainResource.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.extension:additive">
      <path value="Basic.extension"/>
      <sliceName value="additive"/>
      <definition value="Additive associated with container."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
        <profile
                 value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Additive-extension"/>
      </type>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.modifierExtension">
      <path value="Basic.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition
                  value="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."/>
      <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="DomainResource.modifierExtension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.identifier">
      <path value="Basic.identifier"/>
      <short value="Business identifier"/>
      <definition
                  value="Identifier assigned to the resource for business purposes, outside the context of FHIR."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="./identifier"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="id"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.code">
      <path value="Basic.code"/>
      <short value="Kind of Resource"/>
      <definition
                  value="Identifies the &#39;type&#39; of resource - equivalent to the resource name for other resources."/>
      <comment
               value="Because resource references will only be able to indicate &#39;Basic&#39;, the type of reference will need to be specified in a Profile identified as part of the resource.  Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored."/>
      <requirements
                    value="Must be able to distinguish different types of Basic resources."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <patternCodeableConcept>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/breastcancer/CodeSystem/BC-basic-resource-type"/>
          <code value="cimi-entity-SpecimenTreatment"/>
        </coding>
      </patternCodeableConcept>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="BasicResourceType"/>
        </extension>
        <strength value="example"/>
        <description
                     value="Codes for identifying types of resources not yet defined by FHIR"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/basic-resource-type"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value="./code"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="what"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.subject">
      <path value="Basic.subject"/>
      <short value="Identifies the focus of this resource"/>
      <definition
                  value="Identifies the patient, practitioner, device or any other resource that is the &quot;focus&quot; of this resource."/>
      <comment
               value="Optional as not all potential resources will have subjects.  Resources associated with multiple subjects can handle this via extension."/>
      <requirements value="Needed for partitioning the resource by Patient."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map
             value="./participation[typeCode=&#39;SBJ&#39;] (possibly through a ControlAct and Role)"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.focus"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.created">
      <path value="Basic.created"/>
      <short value="When created"/>
      <definition value="Identifies when the resource was first created."/>
      <requirements value="Allows ordering resource instances by time."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="date"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map
             value="./participation[typeCode=&#39;AUT&#39;]/time (possibly through a ControlAct and Role)"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.recorded"/>
      </mapping>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.author">
      <path value="Basic.author"/>
      <short value="Who created"/>
      <definition
                  value="Indicates who was responsible for creating the resource instance."/>
      <requirements value="Needed for partitioning the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map
             value="./participation[typeCode=&#39;SUB&#39;] (possibly through a ControlAct and Role)"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.author"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Basic:cimi-entity-SpecimenTreatment">
      <path value="Basic"/>
      <short value="BC SpecimenTreatment Profile"/>
      <definition value="Treatment performed on the specimen."/>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.extension:additive">
      <path value="Basic.extension"/>
      <sliceName value="additive"/>
      <definition value="Additive associated with container."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
        <profile
                 value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Additive-extension"/>
      </type>
    </element>
    <element id="Basic:cimi-entity-SpecimenTreatment.code">
      <path value="Basic.code"/>
      <patternCodeableConcept>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/breastcancer/CodeSystem/BC-basic-resource-type"/>
          <code value="cimi-entity-SpecimenTreatment"/>
        </coding>
      </patternCodeableConcept>
    </element>
  </differential>
</StructureDefinition>