This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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="5.0.0"/> <name value="Definition"/> <title value="definition"/> <status value="draft"/> <experimental value="false"/> <date value="2023-03-26T15:21:02+11: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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="5.0.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"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> <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())"/> <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="Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)"/> <definition value="An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers."/> <comment value="Can be a `urn:uuid:` or a `urn:oid:` but real `http/s:` addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found."/> <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())"/> <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="A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance."/> <comment value="Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI."/> <requirements value="Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}."/> <min value="0"/> <max value="*"/> <base> <path value="Definition.identifier"/> <min value="0"/> <max value="*"/> </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())"/> <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 can be placed in a lexicographical sequence."/> <comment value="There may be different {{title}}s that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format)."/> <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())"/> <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.versionAlgorithm[x]"> <path value="Definition.versionAlgorithm[x]"/> <short value="How to compare versions"/> <definition value="Indicates the mechanism used to compare versions to determine which is more current."/> <comment value="If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.versionAlgorithm[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <type> <code value="Coding"/> </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())"/> <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="VersionAlgorithm"/> </extension> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/ValueSet/version-algorithm"/> </binding> </element> <element id="Definition.name"> <path value="Definition.name"/> <short value="Name for this {{title}} (computer friendly)"/> <definition value="A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation."/> <comment value="The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly."/> <requirements value="Supports code generation."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.name"/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </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}}."/> <comment value="This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."/> <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())"/> <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/ChargeItemDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EventDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ObservationDefinition"/> <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/Requirements"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/TestPlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/TestScript"/> </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())"/> <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())"/> <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/ChargeItemDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EventDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MessageDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ObservationDefinition"/> <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/Requirements"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/TestPlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/TestScript"/> </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())"/> <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.status"> <path value="Definition.status"/> <short value="draft | active | retired | unknown"/> <definition value="The current state of this {{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."/> <requirements value="Enables tracking the lifecycle of the content and filtering of {{title}}s that are appropriate for use versus not."/> <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())"/> <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/tools/StructureDefinition/binding-definition"> <valueString value="The lifecycle status of an artifact."/> </extension> <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|5.0.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="For testing purposes, not real usage"/> <definition value="A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage."/> <comment value="Allows filtering of {{title}}s that are appropriate for use versus not."/> <requirements value="Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}."/> <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())"/> <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.class"/> </mapping> </element> <element id="Definition.subject"> <path value="Definition.subject"/> <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 intended for use only with specific types of patients or subjects."/> <alias value="Subject type"/> <min value="0"/> <max value="*"/> <base> <path value="Definition.subject"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableReference"/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueString 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."/> </extension> <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[x]"/> </mapping> </element> <element id="Definition.date"> <path value="Definition.date"/> <short value="Date last changed"/> <definition value="The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes."/> <comment value="The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource."/> <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())"/> <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="Name of the publisher/steward (organization or individual)"/> <definition value="The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}."/> <comment 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."/> <requirements value="Helps establish the "authority/credibility" of the {{title}}. May also allow for contact."/> <alias value="author"/> <min value="0"/> <max value="1"/> <base> <path value="Definition.publisher"/> <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())"/> <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())"/> <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 a consumer's perspective."/> <comment value="This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} 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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element id="Definition.useContext"> <path value="Definition.useContext"/> <short value="The context that the content is intended to support"/> <definition value="The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s."/> <comment value="When multiple useContexts are specified, there is no expectation that all or even 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())"/> <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 legal or geographic region in which the {{title}} is intended to be used."/> <comment value="It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)."/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueString value="Countries and regions within which this artifact is targeted for use."/> </extension> <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="Explanation of 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}}. Instead, it provides 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())"/> <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())"/> <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.copyrightLabel"> <path value="Definition.copyrightLabel"/> <short value="Copyright holder and year(s)"/> <definition value="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')."/> <comment value="The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element."/> <requirements value="Defines the content expected to be rendered in all representations of the artifact."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.copyrightLabel"/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Definition.approvalDate"> <path value="Definition.approvalDate"/> <short value="When the {{title}} was approved by publisher"/> <definition value="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage."/> <comment value="The 'date' element may be more recent than the approval date because of minor changes or 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())"/> <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="a pproval"].effectiveTime"/> </mapping> </element> <element id="Definition.lastReviewDate"> <path value="Definition.lastReviewDate"/> <short value="When the {{title}} was last reviewed"/> <definition value="The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date."/> <comment value="If specified, this date follows the original approval date."/> <requirements value="Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant."/> <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())"/> <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;moodCode=EVN;code="review"].effectiveTime"/> </mapping> </element> <element id="Definition.effectivePeriod"> <path value="Definition.effectivePeriod"/> <short value="When the {{title}} is expected to be used"/> <definition value="The period during which the {{title}} content was or is planned to be in active use."/> <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 might be published in 2015."/> <requirements value="Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the {{title}} are or are expected to be used instead."/> <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())"/> <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.topic"> <path value="Definition.topic"/> <short value="Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching"/> <definition value="Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches."/> <requirements value="This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element."/> <min value="0"/> <max value="*"/> <base> <path value="Definition.topic"/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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"/> <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())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueString 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."/> </extension> <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> <element id="Definition.code"> <path value="Definition.code"/> <short value="Service to be done"/> <definition value="A code that identifies the specific service or action that was or is being performed."/> <alias value="type"/> <min value="0"/> <max value="1"/> <base> <path value="Definition.code"/> <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())"/> <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=".code"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> </element> <element id="Definition.product"> <path value="Definition.product"/> <short value="Product to use/manipulate"/> <definition value="Indicates the product supplied or manipulated by this {{title}}."/> <min value="0"/> <max value="1"/> <base> <path value="Definition.product"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </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())"/> <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=".participation[typeCode=PRD].role"/> </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.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:22+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change