This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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: R3 R2

6.14 Resource Profile - Content

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.

6.14.1 Scope and Usage

This specification describes a set of base resources that are used in many different contexts in healthcare. In order to make this manageable, applications and specifications need to be able to describe restrictions on how one or more resource(s) are used, including defining extensions, and controlling how terminology is used. These descriptions need to be able to be shared through repositories of profile definitions, and need to allow for these usage statements to be published, compared, and used as the basis for code, report and UI generation. All these things are done using a "Profile", which itself is represented as a resource.

Profile resources have three main parts:

  1. A metadata section the describes the profile, and supports registry searching
  2. Structures that define and describe how a Resource or Data Type is used
  3. Extension Definitions that define extensions that can be used in structures

This page defines the profile resource, and describes how it is used. Note that as part of the specification itself, a full set of profiles for all resources and data types is published.

A FHIR RESTful server serving the profile resource is also a profile repository. HL7 hosts one for public registration of FHIR profiles at (yet to be done).

6.14.2 Boundaries and Relationships

6.14.2.1 Limitations of Use

A profile specifies a set of rules that the content of a resource must adhere to. In addition, a resource is allowed to describe required behavior for applications that conform to the profile. However the ability of the profile to define this behavior is limited in some respects:

The consequence of this is that if a profile mandates behavior that cannot be ignored, it must also mandate an extension with isModifier=true in the instance. Another way of saying this is that knowledge must be explicit in the instance, not implicit in the profile.

As an example, if a profile wished to describe that any Allergy/Intolerance resource was deemed extremely unlikely, it could not simply say that this is so; instead, it must say that the resource must have an extension that represents this knowledge.

6.14.3 Background and Context

6.14.3.1 Metadata

The profile resource has a set of metadata that is mostly shared with the Value Set and Conformance resources. The metadata describes the profile, and helps find the profile when registered in profile repositories.

identifierThe identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique URI, OID, or UUID)
version

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 and the value should be a timestamp.

Note that there may be multiple resource versions of the profile that have this same identifier. The resource will have updates that create new versions for technical reasons, whereas the stated version number needs to be under the author's control

nameA free text natural language name identifying the Profile
publisherDetails of the individual or organization who accepts responsibility for publishing the profile. This helps establish the "authority/credibility" of the profile.
telecomContact details to assist a user in finding and communicating with the publisher
descriptionA free text natural language description of the profile and its use
requirementsThe Scope and Usage that this profile was created to meet
codeA set of terms from external terminologies that may be used to assist with indexing and searching of profiles
statusThe status of the profile allows filtering of profiles that are appropriate for use vs. not. See the Status Codes
experimentalThis profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
dateThe date that this version of the profile was published
fhirVersionThe version of the FHIR specification on which this profile is based. It is not necessary to specify the version, as most profiles are valid across multiple versions, and the validity of a profile against a particular version of FHIR can easily be checked by tooling.

Notes:

6.14.3.2 Structure

This section specifies restrictions on the content of a resource or a data type. Each structure has a name, which as an internal name unique in the scope of the profile that is used to reuse the structure, and the type that it restricts, which is either a resource or data type defined in the FHIR specification. The following kinds of statements can be made about how a resource or data type is used:

All of these changed definitions SHALL be restrictions that are consistent with the rules defined in the base resource in the FHIR Specification. Note that some of these restrictions can be enforced by tooling (and are by the FHIR tooling), but others cannot be automatically enforced.

A structure definition consists of a linear list of element declarations. The inherent nested structure of the elements is derived from the path value of each element. For instance, a sequence of the element paths like this:

defines the following structure:

 <Root>
   <childA>
     <grandChild/>
   </childA>
   <childB/>
 </Root>

or its JSON equivalent. The structure SHALL be coherent - children are never implied, and the path statements SHALL always be in order. The element list is a linear list rather than being explicitly nested because profile structures are frequently used in multiple places within a single profile, and this re-use is easier in a flat structure.

Profiles are always complete and static. This means that there is never a need to consult any additional profiles to fully understand the element structure that is defined, and there is no need to perform comparison between any profiles to determine the meaning of any profile.

6.14.3.3 Slicing

One common feature of profiles is to take an element that may occur more than once (e.g. in a list), and describe a series of different restrictions on the elements in the list with associated additional meaning with each element, so that the list is split into a series of individual elements or sub-lists. In FHIR, this operation is known as "Slicing" a collection.

Here is an example to illustrate the process:

Slicing diagram

In this example, the base resource defines the "related" element which may occur multiple times. Each related element has a "type" element, and a "target" element which identifies another observation. In this diagram, the contents of the target element are shown in the inner box instead of the showing the target reference explicitly. Note that to avoid adding clutter to this simplified example, the "name" attribute of Observation is shown as (code) not a full CodeableConcept.

The profile for Blood Pressure constrains the related element list into 2 different elements: a systolic element, and a diastolic element. Each of these elements has a fixed value for the type element, and a the profile also fixes the contents of the target observation as well, specifying a fixed LOINC code for the name, and specifying that both have a value of type Quantity. This process is known as "slicing" and the Systolic and Diastolic elements are called "slices".

Note that when the resource is exchanged, the wire format that is exchanged is not altered by the profile. This means that the item profile names defined in the profile ("systolic", etc. in this example) are never exchanged. A resource instance looks like this:

 <Observation>
   ...
   <related>
     <type value="component"/>
     <target ...>
   </related>
   <related>
     <type value="component"/>
     <target ...>
   </related>
 </Observation>

The only way to determine that the first related item corresponds to "Systolic" in the profile is to check the values of the elements - in this case, the name element in the target resource.

In order to make slicing easy to use, particularly in the context of code generation tools that work with profiles, any time slicing is performed in a profile, the profile SHALL nominate a "discriminator" - a contained element that is used to discriminate among the different slices. The profile SHALL fix the value of the contained element for each slice, or if the contained element has a terminology binding, it SHALL be associated with a complete binding with a version specific Value Set reference that enumerates the possible codes in the value set, and where there is no overlap between the codes in the value sets between slices.

Within a profile, a slice is defined using multiple element entries that share a path but have distinct names. These entries together form a "slice group" that is:

  1. Initiated by a "slicing entry" That is, the first element in a slice group must contain a slicing property that defines the discriminator for all members of the group.
  2. Mutually exclusive. This means that each element in a slice group SHALL describe a distinct set of values for the group's discriminator. Because of this constraint, an element in a resource instance will never match more than one element in a given slice group.
  3. Serialized as a group. The entries in a slice group must be adjacent in a serialized Profile, or, if there are any intervening elements, those elements must be "compatible with" the group. Concretely, this means that any intervening elements must have a path that starts with the slice groups's path. For example, an element with a path of Observation.name.extension would be compatible with (and thus, would not "break up") a slice group whose path was Observation.name

The value of the discriminator is either a path name that identifies the child element using a dotted notation, or a URI, which identifies an extension that serves as the discriminator (and which must be found on the element at which the slicing occurs). In the case above, the discriminator is "target.name" (the fact that there is a resource boundary between "target" and "name" is implied, not represented directly).

6.14.3.4 Extension Definitions

A profile can also define extensions. Some profiles only define extensions, and others define extensions as part of defining one or more structures. For an extension definition, the profile defines the code that identifies the extension. The full URI that refers to the extension when it is used in a resource is the identifier (from the metadata above) and then # + the code.

The extension definition also defines the context where the extension can be used (usually a particular path or a data type), and then defines it using the same details used to profile the structural elements.

Note that in the case of a profile that defines an extension, and then uses it, the extension will appear both in the extension definition section, and in one or more places in the structure defined by the profile.

For further discussion of defining and using extensions, along with some examples, see Extensibility.

6.14.3.4.1 Using Extensions in Structures

Defining a extension means that it can be used in a resource somewhere. To actually use a resource, the extension list on the resource needs to be sliced. This is shown in the extensibility examples

Note that the minimum cardinality of an extension SHALL be a valid restriction on the minimum cardinality in the definition of the extension. if the minimum cardinality of the extension is 1 when it is defined, it can only be mandatory when it is added to a profile. This is not recommended - the minimum cardinality of an extension should be 0.

6.14.3.5 Binding Definitions

Coded elements have bindings that link from the element to a definition of the set of possible codes the element may contain. The binding identifies the definition of the set of possible codes, and controls how tightly the set of the possible codes is interpreted.

The set of possible codes is either a formal reference to a value set resource, which may be version specific, or a general reference to some web content that defines a set of codes. The second is most appropriate where set of values is defined by some external standard (such as mime types). Alternatively, where the binding is incomplete (e.g. under development) just a text description of the possible codes can be provided.

Bindings have two properties that define how the set of codes is used: isExtensible and conformance.

The interplay between the meaning of these is subtle but sometimes important. The following table helps define the meanings:

ConformanceisExtensible=falseisExtensible=true
RequiredImplementers SHALL use a code from the defined setImplementers SHALL use a code from the defined set if one is applicable, but otherwise may provide their own code or use text
PreferredImplementers SHOULD use a code from the defined setImplementers SHOULD use a code from the defined set if one is applicable, but MAY provide their own code or use text
ExampleImplementers MAY use a code from the defined setImplementers MAY use a code from the defined set or provide their own code or use text

A profile can define a set of bindings that it uses directly, or it can define a set of bindings for re-use in other profiles. To use bindings in other profiles, just provide an absolute reference. This is a reference to a binding in the same profile:

  <binding value="te:OperationOutcomeSource"/>

This is a reference to a binding in some other profile:

  <binding value="http://hl7.org/fhir/tooling/extensions#OperationOutcomeSource"/>

Bindings can reference value sets by version or independent of version. Value sets may themselves reference other value sets as well as code systems by version or independent of version. Unless all references are version-specific, it is possible that the set of codes permitted in the value set could change over time.

6.14.4 Resource Content

Profile (Resource)The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)identifier : string 0..1The 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 and the value should be a timestampversion : string 0..1A free text natural language name identifying the Profilename : string 1..1Details of the individual or organization who accepts responsibility for publishing the profilepublisher : string 0..1Contact details to assist a user in finding and communicating with the publishertelecom : Contact 0..*A free text natural language description of the profile and its usedescription : string 0..1A set of terms from external terminologies that may be used to assist with indexing and searching of templatescode : Coding 0..*The status of the profile (this element modifies the meaning of other elements)status : code 1..1 <<The lifecycle status of a Resource ProfileResourceProfileStatus>>This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usageexperimental : boolean 0..1The date that this version of the profile was publisheddate : dateTime 0..1The Scope and Usage that this profile was created to meetrequirements : string 0..1The version of the FHIR specification on which this profile is basedfhirVersion : id 0..1MappingAn Internal id that is used to identify this mapping set when specific mappings are madeidentity : id 1..1A URI that identifies the specification that this mapping is expressed touri : uri 0..1A name for the specification that is being mapped toname : string 0..1Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usagecomments : string 0..1StructureThe Resource or Data type being describedtype : code 1..1 <<Either a resource or a data typeFHIRDefinedType>>The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile)name : string 0..1This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that contextpublish : boolean 0..1Human summary: why describe this resource?purpose : string 0..1ElementThe path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resourcepath : string 1..1Codes that define how this element is represented in instances, when the deviation varies from the normal caserepresentation : code 0..* <<How a property is represented on the wirePropertyRepresentation>>The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same elementname : string 0..1SlicingDesignates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance SHALL completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slicesdiscriminator : id 1..1If the matching elements have to occur in the same order as defined in the profileordered : boolean 1..1Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the endrules : code 1..1 <<How slices are interpreted when evaluating an instanceSlicingRules>>ElementDefinitionA concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification)short : string 1..1The definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resourceformal : string 1..1Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etccomments : string 0..1Explains why this element is needed and why it's been constrained as it hasrequirements : string 0..1Identifies additional names by which this element might also be knownsynonym : string 0..*The minimum number of times this element SHALL appear in the instancemin : integer 1..1The maximum number of times this element is permitted to appear in the instancemax : string 1..1Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current elementnameReference : string 0..1Specifies a primitive value that SHALL hold for this element in the instancevalue[x] : * 0..1An example value for this elementexample[x] : * 0..1Indicates the shortest length that SHALL be supported by conformant instances without truncationmaxLength : integer 0..1A reference to an invariant that may make additional statements about the cardinality or value in the instancecondition : id 0..*If true, conformant resource authors SHALL be capable of providing a value for the element and resource consumers SHALL be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supportedmustSupport : boolean 0..1If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular systemisModifier : boolean 1..1TypeRefName of Data type or Resourcecode : code 1..1 <<The type of an element - one of the FHIR data typesDataType>>Identifies a profile that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profileprofile : uri 0..1If the type is a reference to another resource, how the resource is or can be aggreated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundleaggregation : code 0..* <<How resource references can be aggregatedAggregationMode>>ConstraintAllows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinalitykey : id 1..1Used to label the constraint in OCL or in short displays incapable of displaying the full human descriptionname : string 0..1Identifies the impact constraint violation has on the conformance of the instanceseverity : code 1..1 <<SHALL applications comply with this constraint?ConstraintSeverity>>Text that can be used to describe the constraint in messages identifying that the constraint has been violatedhuman : string 1..1XPath expression of constraintxpath : string 1..1BindingA descriptive name for this - can be useful for generating implementation artifactsname : string 1..1If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes aloneisExtensible : boolean 1..1Indicates the degree of conformance expectations associated with this bindingconformance : code 0..1 <<Binding conformance for applicationsBindingConformance>>Describes the intended use of this particular set of codesdescription : string 0..1Points to the value set or external definition that identifies the set of codes to be usedreference[x] : uri|Resource(ValueSet) 0..1MappingAn internal reference to the definition of a mappingidentity : id 1..1Expresses what part of the target specification corresponds to this elementmap : string 1..1SearchParamThe name of the standard or custom search parametername : string 1..1The type of value a search parameter refers to, and how the content is interpretedtype : code 1..1 <<Data types allowed to be used for search parametersSearchParamType>>A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter doesdocumentation : string 1..1An XPath expression that returns a set of elements for the search parameterxpath : string 0..1Types of resource (if a resource is referenced)target : code 0..* <<One of the resource types defined as part of FHIRResourceType>>ExtensionDefnA unique code (within the profile) used to identify the extensioncode : code 1..1Defined so that applications can use this name when displaying the value of the extension to the userdisplay : string 0..1Identifies the type of context to which the extension appliescontextType : code 1..1 <<How an extension context is interpretedExtensionContext>>Identifies the types of resource or data type elements to which the extension can be appliedcontext : string 1..*QueryThe name of a query, which is used in the URI from Conformance statements declaring use of the query. Typically this will also be the name for the _query parameter when the query is called, though in some cases it may be aliased by a server to avoid collisionsname : string 1..1Description of the query - the functionality it offers, and considerations about how it functions and to use itdocumentation : string 1..1An external specification that the content is mapped tomapping0..*Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)slicing0..1The data type or resource that the value of this element is permitted to betype0..*Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instanceconstraint0..*Binds to a value set if this element is coded (code, Coding, CodeableConcept)binding0..1Identifies a concept from an external specification that roughly corresponds to this elementmapping0..*Definition of the content of the element to provide a more specific definition than that contained for the element in the base resourcedefinition0..1Captures constraints on each element within the resourceelement0..*Additional search parameters for implementations to support and/or make use ofsearchParam0..*A constraint statement about what contents a resource or data type may havestructure0..*Definition of the extension and its contentdefinition1..1An extension defined as part of the profileextensionDefn0..*A parameter of a named queryparameter0..*Definition of a named query and its parameters and their meaningquery0..*

This resource is referenced by [Conformance]

<Profile xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: extension, modifierExtension, language, text, and contained -->
 <identifier value="[string]"/><!-- 0..1 Logical id to reference this profile § -->
 <version value="[string]"/><!-- 0..1 Logical id for this version of the profile § -->
 <name value="[string]"/><!-- 1..1 Informal name for this profile § -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) § -->
 <telecom><!-- 0..* Contact Contact information of the publisher § --></telecom>
 <description value="[string]"/><!-- 0..1 Natural language description of the profile § -->
 <code><!-- 0..* Coding Assist with indexing and finding § --></code>
 <status value="[code]"/><!-- 1..1 draft | active | retired § -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage § -->
 <date value="[dateTime]"/><!-- 0..1 Date for this version of the profile § -->
 <requirements value="[string]"/><!-- 0..1 Scope and Usage this profile is for -->
 <fhirVersion value="[id]"/><!-- 0..1 FHIR Version this profile targets § -->
 <mapping>  <!-- 0..* External specification that the content is mapped to -->
  <identity value="[id]"/><!-- 1..1 Internal id when this mapping is used -->
  <uri value="[uri]"/><!-- ?? 0..1 Identifies what this mapping refers to -->
  <name value="[string]"/><!-- ?? 0..1 Names what this mapping refers to -->
  <comments value="[string]"/><!-- 0..1 Versions, Issues, Scope limitations etc -->
 </mapping>
 <structure>  <!-- ?? 0..* A constraint on a resource or a data type -->
  <type value="[code]"/><!-- ?? 1..1 The Resource or Data Type being described -->
  <name value="[string]"/><!-- 0..1 Name for this particular structure (reference target) -->
  <publish value="[boolean]"/><!-- 0..1 This definition is published (i.e. for validation) -->
  <purpose value="[string]"/><!-- 0..1 Human summary: why describe this resource? -->
  <element>  <!-- 0..* Definition of elements in the resource (if no profile) -->
   <path value="[string]"/><!-- 1..1 The path of the element (see the formal definitions) -->
   <representation value="[code]"/><!-- 0..* How this element is represented in instances -->
   <name value="[string]"/><!-- 0..1 Name for this particular element definition (reference target) -->
   <slicing>  <!-- 0..1 This element is sliced - slices follow -->
    <discriminator value="[id]"/><!-- 1..1 Element that used to distinguish the slices -->
    <ordered value="[boolean]"/><!-- 1..1 If elements must be in same order as slices -->
    <rules value="[code]"/><!-- 1..1 closed | open | openAtEnd -->
   </slicing>
   <definition>  <!-- 0..1 More specific definition of the element -->
    <short value="[string]"/><!-- 1..1 Concise definition for xml presentation -->
    <formal value="[string]"/><!-- 1..1 Full formal definition in human language -->
    <comments value="[string]"/><!-- 0..1 Comments about the use of this element -->
    <requirements value="[string]"/><!-- 0..1 Why is this needed? -->
    <synonym value="[string]"/><!-- 0..* Other names -->
    <min value="[integer]"/><!-- 1..1 Minimum Cardinality -->
    <max value="[string]"/><!-- ?? 1..1 Maximum Cardinality (a number or *) -->
    <type>  <!-- 0..* Data type and Profile for this element -->
     <code value="[code]"/><!-- 1..1 Name of Data type or Resource -->
     <profile value="[uri]"/><!-- ?? 0..1 Profile.structure to apply -->
     <aggregation value="[code]"/><!-- ?? 0..* contained | referenced | bundled - how aggregated -->
    </type>
    <nameReference value="[string]"/><!-- ?? 0..1 To another element constraint (by element.name) -->
    <value[x]><!-- ?? 0..1 * Fixed value: [as defined for a primitive type] --></value[x]>
    <example[x]><!-- 0..1 * Example value: [as defined for type] --></example[x]>
    <maxLength value="[integer]"/><!-- 0..1 Length for strings -->
    <condition value="[id]"/><!-- 0..* Reference to invariant about presence -->
    <constraint>  <!-- 0..* Condition that must evaluate to true -->
     <key value="[id]"/><!-- 1..1 Target of 'condition' reference above -->
     <name value="[string]"/><!-- 0..1 Short human label -->
     <severity value="[code]"/><!-- 1..1 error | warning -->
     <human value="[string]"/><!-- 1..1 Human description of constraint -->
     <xpath value="[string]"/><!-- 1..1 XPath expression of constraint -->
    </constraint>
    <mustSupport value="[boolean]"/><!-- 0..1 If the element must supported -->
    <isModifier value="[boolean]"/><!-- 1..1 If this modifies the meaning of other elements -->
    <binding>  <!-- ?? 0..1 ValueSet details if this is coded -->
     <name value="[string]"/><!-- ?? 1..1 Descriptive Name -->
     <isExtensible value="[boolean]"/><!-- ?? 1..1 Can additional codes be used? -->
     <conformance value="[code]"/><!-- ?? 0..1 required | preferred | example -->
     <description value="[string]"/><!-- ?? 0..1 Human explanation of the value set -->
     <reference[x]><!-- ?? 0..1 uri|Resource(ValueSet) Source of value set --></reference[x]>
    </binding>
    <mapping>  <!-- 0..* Map element to another set of definitions -->
     <identity value="[id]"/><!-- ?? 1..1 Reference to mapping declaration -->
     <map value="[string]"/><!-- 1..1 Details of the mapping -->
    </mapping>
   </definition>
  </element>
  <searchParam>  <!-- 0..* Search params defined -->
   <name value="[string]"/><!-- 1..1 Name of search parameter -->
   <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity -->
   <documentation value="[string]"/><!-- 1..1 Contents and meaning of search parameter -->
   <xpath value="[string]"/><!-- 0..1 XPath that extracts the parameter set -->
   <target value="[code]"/><!-- 0..* Types of resource (if a resource reference) -->
  </searchParam>
 </structure>
 <extensionDefn>  <!-- ?? 0..* Definition of an extension -->
  <code value="[code]"/><!-- ?? 1..1 Identifies the extension in this profile -->
  <display value="[string]"/><!-- 0..1 Use this name when displaying the value -->
  <contextType value="[code]"/><!-- 1..1 resource | datatype | mapping | extension -->
  <context value="[string]"/><!-- 1..* Where the extension can be used in instances -->
  <definition><!-- 1..1 Content as for Profile.structure.element.definition Definition of the extension and its content --></definition>
 </extensionDefn>
 <query>  <!-- 0..* Definition of a named query -->
  <name value="[string]"/><!-- 1..1 Special named queries (_query=) -->
  <documentation value="[string]"/><!-- 1..1 Describes the named query -->
  <parameter><!-- 0..* Content as for Profile.structure.searchParam Parameter for the named query --></parameter>
 </query>
</Profile>

Alternate definitions: Schema/Schematron, Resource Profile

6.14.4.1 Terminology Bindings

PathDefinitionTypeReference
Profile.status The lifecycle status of a Resource ProfileFixedhttp://hl7.org/fhir/resource-profile-status
Profile.structure.type Either a resource or a data typeIncompletehttp://hl7.org/fhir/defined-types
Profile.structure.element.representation How a property is represented on the wireFixedhttp://hl7.org/fhir/property-representation
Profile.structure.element.slicing.rules How slices are interpreted when evaluating an instanceFixedhttp://hl7.org/fhir/resource-slicing-rules
Profile.structure.element.definition.type.code The type of an element - one of the FHIR data typesIncompletehttp://hl7.org/fhir/data-types
Profile.structure.element.definition.type.aggregation How resource references can be aggregatedFixedhttp://hl7.org/fhir/resource-aggregation-mode
Profile.structure.element.definition.constraint.severity SHALL applications comply with this constraint?Fixedhttp://hl7.org/fhir/constraint-severity
Profile.structure.element.definition.binding.conformance Binding conformance for applicationsFixedhttp://hl7.org/fhir/binding-conformance
Profile.structure.searchParam.type Data types allowed to be used for search parametersFixedhttp://hl7.org/fhir/search-param-type
Profile.structure.searchParam.target One of the resource types defined as part of FHIRIncompletehttp://hl7.org/fhir/resource-types
Profile.extensionDefn.contextType How an extension context is interpretedFixedhttp://hl7.org/fhir/extension-context

6.14.4.2 Constraints

6.14.5 Interpretation Notes:

6.14.5.1 Common Mapping Targets

http://loinc.orgLOINC code for the element
http://snomed.infoSNOMED CT code for the element
http://hl7.org/v3RIM mappin g
http://hl7.org/v2v2 mapping
http://nema.org/dicomDICOM tag mapping
http://w3.org/vcardvCard equivalent field
http://ihe.net/xdsXDS metadata equivalent

6.14.6 Profiled FHIR

If a profile is unambiguous, then the FHIR profile tooling (ref to be provided when the tooling exists) is able to generate reference implementation based object models that express the profiled model natively, where the object interface does not include prohibited elements, treats declared extensions as primary properties and slices lists according to the profile. This eases the burden on an implementer, though this object model can only be used with a sub-set of the possible resources.

The tooling is also able to generate bi-directional transforms between the normal XML format and an XML representation of this profiled object model and schema for this profiled XML representation. This XML form has extensions promoted into the primary XML form by using the extension code as the XML name and sliced lists are renamed to use the Profile.resource.element.name as the XML element name. Profiles are only suitable for this use if they ensure that there are no clashing extension names when the extension definition spaces are ignored and that the sliced list names are appropriate.

Implementations are allowed to exchange this profiled XML format. Implementations that do so are not fully conformant to FHIR; instead they can claim to be conformant to "Profiled FHIR". Implementations should consider carefully before adopting this approach; while it will reduce the amount of work required to initially implement particular profiles, it will increase the amount of work required to exchange this data with other communities or to re-use tooling and applications that are also used in other contexts. This cost should particularly be considered in light of the fact that the previously discussed tooling allows applications to be written as though they are dealing with "Profiled FHIR" instances when they are in fact sending and receiving fully conformant FHIR instances.

6.14.7 Search Parameters

Search parameters for this resource. The standard parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
_idtokenThe logical resource id associated with the resource (must be supported by all servers)
_languagetokenThe language of the resource
codetokenA code for the profile in the format uri::code (server may choose to do subsumption)Profile.code
datedateThe profile publication dateProfile.date
descriptionstringText search in the description of the profileProfile.description
extensiontokenAn extension code (use or definition)Profile.extensionDefn.code
identifiertokenThe identifier of the profileProfile.identifier
namestringName of the profileProfile.name
publisherstringName of the publisher of the profileProfile.publisher
statustokenThe current status of the profileProfile.status
typetokenType of resource that is constrained in the profileProfile.structure.type
valuesetreferenceA vocabulary binding codeProfile.structure.element.definition.binding.reference[x]
(ValueSet)
versiontokenThe version identifier of the profileProfile.version

comments powered by Disqus