This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
Logical Model Definition
<?xml version="1.0" encoding="UTF-8"?> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Definition"/> <version value="4.4.0"/> <name value="Definition"/> <title value="definition"/> <status value="draft"/> <date value="2020-05-03T08:43:35+10:00"/> <publisher value="Health Level Seven International fhir"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <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="4.4.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/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="Definition"/> <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="*"/> <base> <path value="Definition"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act[moodCode<=DEFN]"/> </mapping> </element> <element id="Definition.url"> <path value="Definition.url"/> <short value="Logical canonical URL 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)."/> <comment value="Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource."/> <requirements value="Allows the {{title}} to be referenced by a single globally unique identifier."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.url"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="Definition.identifier"> <path value="Definition.identifier"/> <short value="Business Identifier for {{title}}"/> <definition value="Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server."/> <comment value="Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#ident ifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number."/> <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"/> <base> <path value="Definition.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </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."/> <comment value="There may be multiple different instances of a {{title}} that have the same identifier but different versions."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.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"/> <base> <path value="Definition.title"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </element> <element id="Definition.derivedFromCanonical"> <path value="Definition.derivedFromCanonical"/> <short value="Based on FHIR protocol or definition"/> <definition value="The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition."/> <requirements value="Protocols and order sets may be refinements of more generic protocols and order sets."/> <min value="0"/> <max value="*"/> <base> <path value="Definition.derivedFromCanonical"/> <min value="0"/> <max value="*"/> </base> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EventDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EvidenceVariable"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=DEFN].target"/> </mapping> </element> <element id="Definition.derivedFromUri"> <path value="Definition.derivedFromUri"/> <short value="Based on external protocol or definition"/> <definition value="The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition."/> <comment value="This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier."/> <requirements value="Protocols and order sets may be refinements of more generic protocols and order sets."/> <min value="0"/> <max value="*"/> <base> <path value="Definition.derivedFromUri"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <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."/> <comment 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="*"/> <base> <path value="Definition.partOf"/> <min value="0"/> <max value="*"/> </base> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EventDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EvidenceVariable"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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="*"/> <base> <path value="Definition.replaces"/> <min value="0"/> <max value="*"/> </base> <type> <code value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EventDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EvidenceVariable"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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 | retired | unknown"/> <definition value="The current state of the {{title}}."/> <comment value="A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - 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"/> <base> <path value="Definition.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PublicationStatus"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="The lifecycle status of an artifact."/> <valueSet value="http://hl7.org/fhir/ValueSet/publication-status|4.4.0"/> </binding> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.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."/> <comment 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"/> <base> <path value="Definition.experimental"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="This is labeled as "Is Modifier" because applications should not use an experimental {{title}} in production."/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.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="Subject type"/> <min value="0"/> <max value="1"/> <base> <path value="Definition.subject[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DefinitionSubject"/> </extension> <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="FiveWs.subject"/> </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"/> <base> <path value="Definition.date"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.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 "authority/credibility" 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"/> <base> <path value="Definition.publisher"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.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."/> <comment value="May be a web site, an email address, a telephone number, etc."/> <min value="0"/> <max value="*"/> <base> <path value="Definition.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactDetail"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CALLBCK].role"/> </mapping> </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."/> <comment 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"/> <base> <path value="Definition.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </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."/> <comment 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="*"/> <base> <path value="Definition.useContext"/> <min value="0"/> <max value="*"/> </base> <type> <code value="UsageContext"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> </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="*"/> <base> <path value="Definition.jurisdiction"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Jurisdiction"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="Countries and regions within which this artifact is targeted for use."/> <valueSet value="http://hl7.org/fhir/ValueSet/jurisdiction"/> </binding> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> </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."/> <comment value="This element does not describe the usage of the {{title}}. Rather it is 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"/> <base> <path value="Definition.purpose"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".reasonCode.text"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </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"/> <base> <path value="Definition.copyright"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> </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."/> <comment value="The date may be more recent than the approval date because of minor changes / editorial corrections."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.approvalDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval "].effectiveTime"/> </mapping> </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."/> <comment value="If specified, this is usually after the approval date."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.lastReviewDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;m oodCode=EVN;code="review"].effectiveTime"/> </mapping> </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."/> <comment 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"/> <base> <path value="Definition.effectivePeriod"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (to add?)"/> </mapping> </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"/> <base> <path value="Definition.performerType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PerformerType"/> </extension> <strength value="example"/> <description value="Identifies types of practitioners, devices or other agents that are intended to perform a defined action. While the detailed constraints of relevant agents 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="FiveWs.actor"/> </mapping> </element> </snapshot> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.