Definition.xml

Logical Model Definition

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Definition"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Definition"/>
  <name value="Definition"/>
  <title value="definition"/>
  <status value="draft"/>
  <publisher value="Health Level Seven International fhir"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2016-12-06T12:22:34+11:00"/>
  <description value="Logical Model: A pattern to be followed by resources that represent a specific proposal,
   plan and/or order for some sort of action or service."/>
  <fhirVersion value="1.8.0"/>
  <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="logical"/>
  <abstract value="false"/>
  <snapshot>
    <element id="Definition">
      <path value="Definition"/>
      <short value="Definition Pattern"/>
      <definition value="A pattern to be followed by resources that represent a specific proposal, plan and/or
       order for some sort of action or service."/>
      <min value="0"/>
      <max value="*"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act[moodCode&lt;=DEFN]"/>
      </mapping>
    </element>
    <element id="Definition.url">
      <path value="Definition.url"/>
      <short value="Logical uri to reference this {{title}} (globally unique)"/>
      <definition value="An absolute URL that is used to identify this {{title}} when it is referenced in a specification,
       model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD
       be an address at which this {{title}} is (or will be) published. The URL SHOULD include
       the major version of the {{title}}. For more information see [Technical and Business Versions](resou
      rce.html#versions)."/>
      <comments value="Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred."/>
      <requirements value="Allows the {{title}} to be referenced by a single globally unique identifier."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".identifier"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="id"/>
      </mapping>
    </element>
    <element id="Definition.identifier">
      <path value="Definition.identifier"/>
      <short value="Business Identifer for {{title}}"/>
      <definition value="Identifier assigned to this {{title}} request by the requester, performer and other systems."/>
      <requirements value="Allows identification of the {{title}} as it is known by various participating systems
       and in a way that remains consistent across servers."/>
      <min value="0"/>
      <max value="1"/>
      <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="Definition.version">
      <path value="Definition.version"/>
      <short value="Business version of the {{title}}"/>
      <definition value="The identifier that is used to identify this version of the {{title}} when it is referenced
       in a specification, model, design or instance. This is an arbitrary value managed by the
       {{title}} author and is not expected to be globally unique. For example, it might be a
       timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation
       that versions are orderable."/>
      <comments value="There may be multiple different instances of a {{title}} that have the same identifier
       but different versions."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="w5"/>
        <map value="id.version"/>
      </mapping>
    </element>
    <element id="Definition.title">
      <path value="Definition.title"/>
      <short value="Name for this {{title}} (Human friendly)"/>
      <definition value="A short, descriptive, user-friendly title for the {{title}}."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Definition.definition">
      <path value="Definition.definition"/>
      <short value="Instantiates protocol or definition"/>
      <definition value="A protocol, guideline, orderset or other definition that is adhered to in whole or in
       part by this definition."/>
      <comments value="[The allowed reference resources may be adjusted as appropriate for the request resource]."/>
      <requirements value="Protocols and order sets may be refinements of more generic protocols and order sets."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Definition"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".outboundRelationship[typeCode=DEFN].target"/>
      </mapping>
    </element>
    <element id="Definition.partOf">
      <path value="Definition.partOf"/>
      <short value="Part of referenced definition"/>
      <definition value="A larger definition of which this particular definition is a component or step."/>
      <comments value="[The allowed reference resources may be adjusted as appropriate for the event resource]."/>
      <requirements value="E.g. Drug administration as part of a procedure, procedure as part of observation, etc."/>
      <alias value="container"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Definition"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".inboundRelationship[typeCode=COMP].source[moodCode=DEFN]"/>
      </mapping>
    </element>
    <element id="Definition.replaces">
      <path value="Definition.replaces"/>
      <short value="Request(s) replaced by this request"/>
      <definition value="Completed or terminated request(s) whose function is taken by this new request."/>
      <requirements value="As new versions of a protocol or guideline are defined, allows identification of what
       versions are replaced by a new instance."/>
      <alias value="supersedes"/>
      <alias value="prior"/>
      <alias value="renewed order"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Definition"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".outboundRelationship[typeCode=RPLC].target"/>
      </mapping>
    </element>
    <element id="Definition.status">
      <path value="Definition.status"/>
      <short value="draft | active | withdrawn"/>
      <definition value="The current state of the {{title}}."/>
      <comments value="A nominal state-transition diagram can be found in the [[definition.html#statemachine
       | Definition pattern]] documentation  Unknown does not represent &quot;other&quot; - one
       of the defined statuses must apply.  Unknown is used when the authoring system is not
       sure what the current status is."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="Codes identifying the stage lifecycle stage of a definition"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/definition-status"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".status"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="status"/>
      </mapping>
    </element>
    <element id="Definition.experimental">
      <path value="Definition.experimental"/>
      <short value="If for testing purposes, not real usage"/>
      <definition value="A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/mar
      keting), and is not intended to be used for genuine usage."/>
      <comments value="Allows filtering of {{title}} that are appropriate for use vs. not."/>
      <requirements value="Enables experimental content to be developed following the same life-cycle as a production-level
       {{title}} would."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="w5"/>
        <map value="class"/>
      </mapping>
    </element>
    <element id="Definition.subject[x]">
      <path value="Definition.subject[x]"/>
      <short value="Type of individual the defined service is for"/>
      <definition value="A code or group definition that describes the intended subject of instantiations of this
       definition."/>
      <requirements value="Many protocols, order sets and guidelines are inted for use only with specific types of
       patients or subjects."/>
      <alias value="patient"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="Codes identifying the type of subject intended to be the recpient or focus of the defined
         action.  These should ideally be consistent across definition resources."/>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=SBJ].role"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.focus"/>
      </mapping>
    </element>
    <element id="Definition.date">
      <path value="Definition.date"/>
      <short value="Date status first applied"/>
      <definition value="For draft definitions, indicates the date of initial creation.  For active definitions,
       represents the date of activation.  For withdrawn definitions, indicates the date of withdrawal."/>
      <alias value="created"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].time"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.recorded"/>
      </mapping>
    </element>
    <element id="Definition.publisher">
      <path value="Definition.publisher"/>
      <short value="The name of the individual or organization that published the {{title}}"/>
      <definition value="Helps establish the &quot;authority/credibility&quot; of the {{title}}.  May also allow
       for contact."/>
      <requirements value="Usually an organization, but may be an individual. The publisher (or steward) of the {{title}}
       is the organization or individual primarily responsible for the maintenance and upkeep
       of the {{title}}. This is not necessarily the same individual or organization that developed
       and initially authored the content. The publisher is the primary point of contact for
       questions or issues with the {{title}}. This item SHOULD be populated unless the information
       is available from context."/>
      <alias value="author"/>
      <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/Organization"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].role"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.author"/>
      </mapping>
    </element>
    <element id="Definition.contact">
      <path value="Definition.contact"/>
      <short value="Contact details for the publisher"/>
      <definition value="Contact details to assist a user in finding and communicating with the publisher."/>
      <comments value="May be a web site, an email address, a telephone number, etc."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactDetail"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Definition.useContext">
      <path value="Definition.useContext"/>
      <short value="Content intends to support these contexts"/>
      <definition value="The content was developed with a focus and intent of supporting the contexts that are
       listed. These terms may be used to assist with indexing and searching of code system definitions."/>
      <comments value="When multiple usageContexts are specified, there is no expectation for whether all or
       any of the contexts apply."/>
      <requirements value="Assist in searching for appropriate content."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="UsageContext"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Definition.jurisdiction">
      <path value="Definition.jurisdiction"/>
      <short value="Intended jurisdiction for {{title}} (if applicable)"/>
      <definition value="A jurisdiction in which the {{title}} is intended to be used."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="extensible"/>
        <description value="Countries and regions within which this artifact is targeted for use"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/jurisdiction"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="Definition.description">
      <path value="Definition.description"/>
      <short value="Natural language description of the {{title}}"/>
      <definition value="A free text natural language description of the {{title}} from the consumer's perspective."/>
      <comments value="This description can be used to capture details such as why the {{title}} was built, comments
       about misuse, instructions for clinical use and interpretation, literature references,
       examples from the paper world, etc. It is not a rendering of the module as conveyed in
       the text field of the resource itself. This item SHOULD be populated unless the information
       is available from context."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="markdown"/>
      </type>
    </element>
    <element id="Definition.purpose">
      <path value="Definition.purpose"/>
      <short value="Why this {{title}} is defined"/>
      <definition value="Explains why this {{title}} is needed and why it has been designed as it has."/>
      <comments value="This element does not describe the usage of the {{title}} (See, e.g, the comments element,
       or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed
       or ''why'' it is defined as it is.  This may be used to point to source materials or specifications
       that drove the structure of this {{title}}."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="markdown"/>
      </type>
      <mapping>
        <identity value="w5"/>
        <map value="why"/>
      </mapping>
    </element>
    <element id="Definition.copyright">
      <path value="Definition.copyright"/>
      <short value="Use and/or publishing restrictions"/>
      <definition value="A copyright statement relating to the {{title}} and/or its contents. Copyright statements
       are generally legal restrictions on the use and publishing of the {{title}}."/>
      <requirements value="Consumers of the {{title}} must be able to determine any legal restrictions on the use
       of the artifact and/or its content."/>
      <alias value="License"/>
      <alias value="Restrictions"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="markdown"/>
      </type>
    </element>
    <element id="Definition.approvalDate">
      <path value="Definition.approvalDate"/>
      <short value="When {{title}} approved by publisher"/>
      <definition value="The date on which the asset content was approved by the publisher. Approval happens once
       when the content is officially approved for usage."/>
      <comments value="The date may be more recent than the approval date because of minor changes / editorial
       corrections."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="date"/>
      </type>
    </element>
    <element id="Definition.lastReviewDate">
      <path value="Definition.lastReviewDate"/>
      <short value="Last review date for the {{title}}"/>
      <definition value="The date on which the asset content was last reviewed. Review happens periodically after
       that, but doesn't change the original approval date."/>
      <comments value="If specified, this is usually after the approval date."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="date"/>
      </type>
    </element>
    <element id="Definition.effectivePeriod">
      <path value="Definition.effectivePeriod"/>
      <short value="The effective date range for the {{title}}"/>
      <definition value="The period during which the {{title}} content was or is planned to be effective."/>
      <comments value="The effective period for a {{title}}  determines when the content is applicable for usage
       and is independent of publication and review dates. For example, a measure intended to
       be used for the year 2016 would be published in 2015."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Period"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element id="Definition.performerType">
      <path value="Definition.performerType"/>
      <short value="Desired kind of service performer"/>
      <definition value="The type of individual that is expected to act upon instances of this definition."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="Identifies types of practitioners, devices or others that are intended to perform a defined
         action.  While the detailed constraints of relevant providers will vary by resource, some
         degree of consistency around recommended codes across request and definition resources
         would be desirable"/>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.actor"/>
      </mapping>
    </element>
  </snapshot>
</StructureDefinition>