2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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 R2
Profile for structuredefinition
<Profile xmlns="http://hl7.org/fhir"> <id value="StructureDefinition"/> <meta> <lastUpdated value="2015-02-23T09:07:27.665+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/Profile/StructureDefinition"/> <name value="StructureDefinition"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/> </telecom> </contact> <description value="Base Profile for StructureDefinition Resource"/> <status value="draft"/> <date value="2015-02-23T09:07:27+11:00"/> <mapping> <identity value="iso11179"/> <uri value="http://metadata-standards.org/11179/"/> <name value="ISO 11179"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="StructureDefinition"/> <snapshot> <element> <path value="StructureDefinition"/> <short value="Resource Profile"/> <definition value="A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."/> <comments value="Often called a clinical template."/> <synonym value="Template"/> <min value="1"/> <max value="1"/> <constraint> <key value="sdf-5"/> <severity value="error"/> <human value="If the type is 'extension' then the structure must have context information"/> <xpath value="not(f:type/@value = 'extension') or (f:context and f:contextType)"/> </constraint> <constraint> <key value="sdf-4"/> <severity value="error"/> <human value="A structure must have a base unless it’s type is 'abstract'"/> <xpath value="(f:type/@value = 'abstract') or f:base"/> </constraint> <constraint> <key value="sdf-6"/> <severity value="error"/> <human value="A structure must have either a differential, or a snapshot (or both)"/> <xpath value="f:snapshot or f:differential"/> </constraint> </element> <element> <path value="StructureDefinition.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="StructureDefinition.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="StructureDefinition.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="StructureDefinition.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <description value="A human language"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="StructureDefinition.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="StructureDefinition.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.url"/> <short value="Literal URL used to reference this profile"/> <definition value="The URL at which this profile is (or will be) published, and which is used to reference this profile in extension urls and tag values in operational FHIR systems."/> <requirements value="So you can say, in a profile, what the full extensions URLs should be. This is required to allow hosting profiles on multiple different servers, and to allow for the editorial process."/> <synonym value="url"/> <synonym value="authoritative-url"/> <synonym value="destination"/> <synonym value="identity"/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element> <path value="StructureDefinition.identifier"/> <short value="Other identifiers for the profile"/> <definition value="Formal identifier that is used to identify this profile when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI)."/> <comments value="N/A."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Identifier part"/> </mapping> </element> <element> <path value="StructureDefinition.version"/> <short value="Logical id for this version of the profile"/> <definition value="The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually."/> <comments value="N/A."/> <requirements value="There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Version"/> </mapping> </element> <element> <path value="StructureDefinition.name"/> <short value="Informal name for this profile"/> <definition value="A free text natural language name identifying the Profile."/> <comments value="Not expected to be globally unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.display"/> <short value="Use this name when displaying the value"/> <definition value="Defined so that applications can use this name when displaying the value of the extension to the user."/> <comments value="Applications don't have to use this name, but can always fall back to it. In the absence of a value for this element, use the name."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.publisher"/> <short value="Name of the publisher (Organization or individual)"/> <definition value="The name of the individual or organization that published the structure definition."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the structure definition. May also allow for contact."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Registration Authority"/> </mapping> </element> <element> <path value="StructureDefinition.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.contact.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.contact.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.contact.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.contact.name"/> <short value="Name of a individual to contact"/> <definition value="The name of an individual to contact regarding the structure definition."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.description"/> <short value="Natural language description of the profile"/> <definition value="A free text natural language description of the profile and its use."/> <comments value="This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in StructureDefinitio n.text. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.requirements"/> <short value="Scope and Usage this structure definition is for"/> <definition value="Explains why this structure definition is needed and why it's been constrained as it has."/> <comments value="This element does not describe the usage of the structure definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.copyright"/> <short value="Use and/or Publishing restrictions"/> <definition value="A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings."/> <synonym value="License"/> <synonym value="Restrictions"/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.code"/> <short value="Assist with indexing and finding"/> <definition value="A set of terms from external terminologies that may be used to assist with indexing and searching of templates."/> <requirements value="Assist in searching for appropriate profiles."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="keywords"/> </mapping> </element> <element> <path value="StructureDefinition.status"/> <short value="draft | active | retired"/> <definition value="The status of the profile."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <name value="StructureDefinitionStatus"/> <isExtensible value="false"/> <conformance value="required"/> <description value="The lifecycle status of a StructureDefinition"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/structure-definition-status"/> </referenceReference> </binding> <mapping> <identity value="iso11179"/> <map value="Registration status"/> </mapping> </element> <element> <path value="StructureDefinition.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Registration status"/> </mapping> </element> <element> <path value="StructureDefinition.date"/> <short value="Date for this version of the profile"/> <definition value="The date that this version of the profile was published."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.fhirVersion"/> <short value="FHIR Version this profile targets"/> <definition value="The version of the FHIR specification on which this profile is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 0.4.0 for this version."/> <comments value="A profile does not need to specify the target it applies to,as profiles will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a profile is consistent with a particular profile if desired."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.mapping"/> <short value="External specification that the content is mapped to"/> <definition value="An external specification that the content is mapped to."/> <min value="0"/> <max value="*"/> <constraint> <key value="sdf-2"/> <severity value="error"/> <human value="Must have at a name or a uri (or both)"/> <xpath value="exists(f:uri) or exists(f:name)"/> </constraint> </element> <element> <path value="StructureDefinition.mapping.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.mapping.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.mapping.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.mapping.identity"/> <short value="Internal id when this mapping is used"/> <definition value="An Internal id that is used to identify this mapping set when specific mappings are made."/> <comments value="The specification is described once, with general comments, and then specific mappings are made that reference this declaration."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="StructureDefinition.mapping.uri"/> <short value="Identifies what this mapping refers to"/> <definition value="A URI that identifies the specification that this mapping is expressed to."/> <comments value="A formal identity for the specification being mapped to helps with identifying maps consistently."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <condition value="sdf-2"/> </element> <element> <path value="StructureDefinition.mapping.name"/> <short value="Names what this mapping refers to"/> <definition value="A name for the specification that is being mapped to."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sdf-2"/> </element> <element> <path value="StructureDefinition.mapping.comments"/> <short value="Versions, Issues, Scope limitations etc"/> <definition value="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.type"/> <short value="abstract | type | resource | constraint | extension"/> <definition value="Defines the type of structure that this definition is describing."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="StructureDefinitionType"/> <isExtensible value="false"/> <conformance value="required"/> <description value="Defines the type of structure that a definition is describing"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/structure-definition-type"/> </referenceReference> </binding> </element> <element> <path value="StructureDefinition.contextType"/> <short value="resource | datatype | mapping | extension"/> <definition value="Identifies the type of context to which the extension applies."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="sdf-5"/> <binding> <name value="ExtensionContext"/> <isExtensible value="false"/> <conformance value="required"/> <description value="How an extension context is interpreted"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/extension-context"/> </referenceReference> </binding> </element> <element> <path value="StructureDefinition.context"/> <short value="Where the extension can be used in instances"/> <definition value="Identifies the types of resource or data type elements to which the extension can be applied."/> <comments value="If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of "string" doesn't mean that the extension can be used with one of the string patterns such as "id" etc."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <condition value="sdf-5"/> </element> <element> <path value="StructureDefinition.base"/> <short value="Structure that this set of constraints applies to"/> <definition value="The structure that is the base on which this set of constraints is derived from."/> <comments value="If differential constraints are specified in this structure, they are applied to the base in a "differential" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snaphots from differential constraints."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <condition value="sdf-4"/> </element> <element> <path value="StructureDefinition.snapshot"/> <short value="Snapshot view of the structure"/> <definition value="A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base profile."/> <min value="0"/> <max value="1"/> <condition value="sdf-6"/> <constraint> <key value="sdf-1"/> <severity value="error"/> <human value="Element paths must be unique - or not (LM)"/> <xpath value="count(f:element) >= count(distinct-values(f:element/f:path/@value))"/> </constraint> <constraint> <key value="sdf-3"/> <severity value="error"/> <human value="If a structure is a snapshot, then each element definition must have a formal definition, and cardinalities"/> <xpath value="exists(f:base) or (count(f:element) = count(f:element[exists(f:formal) and exists(f:min) and exists(f:max)]))"/> </constraint> </element> <element> <path value="StructureDefinition.snapshot.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.snapshot.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.snapshot.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.snapshot.element"/> <short value="Definition of elements in the resource (if no profile)"/> <definition value="Captures constraints on each element within the resource."/> <min value="1"/> <max value="*"/> <type> <code value="ElementDefinition"/> </type> <condition value="sdf-3"/> <mapping> <identity value="iso11179"/> <map value="--"/> </mapping> </element> <element> <path value="StructureDefinition.differential"/> <short value="Differential view of the structure"/> <definition value="A differential view is expressed relative to the base profile - a statement of differences that it applies."/> <min value="0"/> <max value="1"/> <condition value="sdf-6"/> </element> <element> <path value="StructureDefinition.differential.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.differential.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="StructureDefinition.differential.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="StructureDefinition.differential.element"/> <short value="Definition of elements in the resource (if no profile)"/> <definition value="Captures constraints on each element within the resource."/> <min value="1"/> <max value="*"/> <type> <code value="ElementDefinition"/> </type> <mapping> <identity value="iso11179"/> <map value="--"/> </mapping> </element> </snapshot> <differential> <element> <path value="StructureDefinition"/> <short value="Resource Profile"/> <definition value="A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."/> <comments value="Often called a clinical template."/> <synonym value="Template"/> <min value="1"/> <max value="1"/> <constraint> <key value="sdf-5"/> <severity value="error"/> <human value="If the type is 'extension' then the structure must have context information"/> <xpath value="not(f:type/@value = 'extension') or (f:context and f:contextType)"/> </constraint> <constraint> <key value="sdf-4"/> <severity value="error"/> <human value="A structure must have a base unless it’s type is 'abstract'"/> <xpath value="(f:type/@value = 'abstract') or f:base"/> </constraint> <constraint> <key value="sdf-6"/> <severity value="error"/> <human value="A structure must have either a differential, or a snapshot (or both)"/> <xpath value="f:snapshot or f:differential"/> </constraint> </element> <element> <path value="StructureDefinition.url"/> <short value="Literal URL used to reference this profile"/> <definition value="The URL at which this profile is (or will be) published, and which is used to reference this profile in extension urls and tag values in operational FHIR systems."/> <requirements value="So you can say, in a profile, what the full extensions URLs should be. This is required to allow hosting profiles on multiple different servers, and to allow for the editorial process."/> <synonym value="url"/> <synonym value="authoritative-url"/> <synonym value="destination"/> <synonym value="identity"/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element> <path value="StructureDefinition.identifier"/> <short value="Other identifiers for the profile"/> <definition value="Formal identifier that is used to identify this profile when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI)."/> <comments value="N/A."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Identifier part"/> </mapping> </element> <element> <path value="StructureDefinition.version"/> <short value="Logical id for this version of the profile"/> <definition value="The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually."/> <comments value="N/A."/> <requirements value="There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Version"/> </mapping> </element> <element> <path value="StructureDefinition.name"/> <short value="Informal name for this profile"/> <definition value="A free text natural language name identifying the Profile."/> <comments value="Not expected to be globally unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.display"/> <short value="Use this name when displaying the value"/> <definition value="Defined so that applications can use this name when displaying the value of the extension to the user."/> <comments value="Applications don't have to use this name, but can always fall back to it. In the absence of a value for this element, use the name."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.publisher"/> <short value="Name of the publisher (Organization or individual)"/> <definition value="The name of the individual or organization that published the structure definition."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the structure definition. May also allow for contact."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Registration Authority"/> </mapping> </element> <element> <path value="StructureDefinition.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.contact.name"/> <short value="Name of a individual to contact"/> <definition value="The name of an individual to contact regarding the structure definition."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.description"/> <short value="Natural language description of the profile"/> <definition value="A free text natural language description of the profile and its use."/> <comments value="This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in StructureDefinitio n.text. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.requirements"/> <short value="Scope and Usage this structure definition is for"/> <definition value="Explains why this structure definition is needed and why it's been constrained as it has."/> <comments value="This element does not describe the usage of the structure definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.copyright"/> <short value="Use and/or Publishing restrictions"/> <definition value="A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings."/> <synonym value="License"/> <synonym value="Restrictions"/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.code"/> <short value="Assist with indexing and finding"/> <definition value="A set of terms from external terminologies that may be used to assist with indexing and searching of templates."/> <requirements value="Assist in searching for appropriate profiles."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="keywords"/> </mapping> </element> <element> <path value="StructureDefinition.status"/> <short value="draft | active | retired"/> <definition value="The status of the profile."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <name value="StructureDefinitionStatus"/> <isExtensible value="false"/> <conformance value="required"/> <description value="The lifecycle status of a StructureDefinition"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/structure-definition-status"/> </referenceReference> </binding> <mapping> <identity value="iso11179"/> <map value="Registration status"/> </mapping> </element> <element> <path value="StructureDefinition.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <requirements value="Allows filtering of profiles that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="iso11179"/> <map value="Registration status"/> </mapping> </element> <element> <path value="StructureDefinition.date"/> <short value="Date for this version of the profile"/> <definition value="The date that this version of the profile was published."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.fhirVersion"/> <short value="FHIR Version this profile targets"/> <definition value="The version of the FHIR specification on which this profile is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 0.4.0 for this version."/> <comments value="A profile does not need to specify the target it applies to,as profiles will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a profile is consistent with a particular profile if desired."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element> <path value="StructureDefinition.mapping"/> <short value="External specification that the content is mapped to"/> <definition value="An external specification that the content is mapped to."/> <min value="0"/> <max value="*"/> <constraint> <key value="sdf-2"/> <severity value="error"/> <human value="Must have at a name or a uri (or both)"/> <xpath value="exists(f:uri) or exists(f:name)"/> </constraint> </element> <element> <path value="StructureDefinition.mapping.identity"/> <short value="Internal id when this mapping is used"/> <definition value="An Internal id that is used to identify this mapping set when specific mappings are made."/> <comments value="The specification is described once, with general comments, and then specific mappings are made that reference this declaration."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="StructureDefinition.mapping.uri"/> <short value="Identifies what this mapping refers to"/> <definition value="A URI that identifies the specification that this mapping is expressed to."/> <comments value="A formal identity for the specification being mapped to helps with identifying maps consistently."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <condition value="sdf-2"/> </element> <element> <path value="StructureDefinition.mapping.name"/> <short value="Names what this mapping refers to"/> <definition value="A name for the specification that is being mapped to."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sdf-2"/> </element> <element> <path value="StructureDefinition.mapping.comments"/> <short value="Versions, Issues, Scope limitations etc"/> <definition value="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="StructureDefinition.type"/> <short value="abstract | type | resource | constraint | extension"/> <definition value="Defines the type of structure that this definition is describing."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="StructureDefinitionType"/> <isExtensible value="false"/> <conformance value="required"/> <description value="Defines the type of structure that a definition is describing"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/structure-definition-type"/> </referenceReference> </binding> </element> <element> <path value="StructureDefinition.contextType"/> <short value="resource | datatype | mapping | extension"/> <definition value="Identifies the type of context to which the extension applies."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="sdf-5"/> <binding> <name value="ExtensionContext"/> <isExtensible value="false"/> <conformance value="required"/> <description value="How an extension context is interpreted"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/extension-context"/> </referenceReference> </binding> </element> <element> <path value="StructureDefinition.context"/> <short value="Where the extension can be used in instances"/> <definition value="Identifies the types of resource or data type elements to which the extension can be applied."/> <comments value="If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of "string" doesn't mean that the extension can be used with one of the string patterns such as "id" etc."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <condition value="sdf-5"/> </element> <element> <path value="StructureDefinition.base"/> <short value="Structure that this set of constraints applies to"/> <definition value="The structure that is the base on which this set of constraints is derived from."/> <comments value="If differential constraints are specified in this structure, they are applied to the base in a "differential" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snaphots from differential constraints."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <condition value="sdf-4"/> </element> <element> <path value="StructureDefinition.snapshot"/> <short value="Snapshot view of the structure"/> <definition value="A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base profile."/> <min value="0"/> <max value="1"/> <condition value="sdf-6"/> <constraint> <key value="sdf-1"/> <severity value="error"/> <human value="Element paths must be unique - or not (LM)"/> <xpath value="count(f:element) >= count(distinct-values(f:element/f:path/@value))"/> </constraint> <constraint> <key value="sdf-3"/> <severity value="error"/> <human value="If a structure is a snapshot, then each element definition must have a formal definition, and cardinalities"/> <xpath value="exists(f:base) or (count(f:element) = count(f:element[exists(f:formal) and exists(f:min) and exists(f:max)]))"/> </constraint> </element> <element> <path value="StructureDefinition.snapshot.element"/> <short value="Definition of elements in the resource (if no profile)"/> <definition value="Captures constraints on each element within the resource."/> <min value="1"/> <max value="*"/> <type> <code value="ElementDefinition"/> </type> <condition value="sdf-3"/> <mapping> <identity value="iso11179"/> <map value="--"/> </mapping> </element> <element> <path value="StructureDefinition.differential"/> <short value="Differential view of the structure"/> <definition value="A differential view is expressed relative to the base profile - a statement of differences that it applies."/> <min value="0"/> <max value="1"/> <condition value="sdf-6"/> </element> <element> <path value="StructureDefinition.differential.element"/> <short value="Definition of elements in the resource (if no profile)"/> <definition value="Captures constraints on each element within the resource."/> <min value="1"/> <max value="*"/> <type> <code value="ElementDefinition"/> </type> <mapping> <identity value="iso11179"/> <map value="--"/> </mapping> </element> </differential> </Profile>
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.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:24+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change