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
Detailed Descriptions for the elements in the Profile resource.
Profile | |
Definition | 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. |
Control | 1..1 |
Alternate Names | Template |
Comments | Often called a clinical template. |
Invariants | Defined on this element prf-3: Parameter names must be unique within structure (xpath: count(distinct-values(f:searchParam/f:name/@value)) =count(f:searchParam/f:name)) |
Profile.url | |
Definition | 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. |
Control | 1..1 |
Type | uri |
Requirements | 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. |
Alternate Names | url; authoritative-url; destination |
gForge Tasks | 3265 |
Profile.identifier | |
Definition | A 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 uri). |
Control | 0..1 |
Type | Identifier |
Summary | true |
Comments | This is for use if it's not possible to use the literal URI - such as in a CDA template ID. |
Profile.version | |
Definition | 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. |
Control | 0..1 |
Type | string |
Requirements | 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. |
Summary | true |
Comments | N/A. |
Profile.name | |
Definition | A free text natural language name identifying the Profile. |
Control | 1..1 |
Type | string |
Summary | true |
Comments | Not expected to be globally unique. |
Profile.publisher | |
Definition | The name of the individual or organization that published the profile. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the profile. May also allow for contact. |
Summary | true |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
Profile.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
Profile.contact.name | |
Definition | The name of an individual to contact regarding the profile. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
Profile.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
Profile.description | |
Definition | A free text natural language description of the profile and its use. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | 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 Profile.text. This item SHOULD be populated unless the information is available from context. |
Profile.code | |
Definition | A set of terms from external terminologies that may be used to assist with indexing and searching of templates. |
Control | 0..* |
Type | Coding |
Requirements | Assist in searching for appropriate profiles. |
Summary | true |
Profile.status | |
Definition | The status of the profile. |
Control | 1..1 |
Binding | ResourceProfileStatus: Required: http://hl7.org/fhir/resource-profile-status (The lifecycle status of a Resource Profile) |
Type | code |
Is Modifier | true |
Requirements | Allows filtering of profiles that are appropriate for use vs. not. |
Summary | true |
Profile.experimental | |
Definition | This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Requirements | Allows filtering of profiles that are appropriate for use vs. not. |
Summary | true |
Profile.date | |
Definition | The date that this version of the profile was published. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Profile.requirements | |
Definition | The Scope and Usage that this profile was created to meet. |
Control | 0..1 |
Type | string |
Profile.fhirVersion | |
Definition | 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. |
Control | 0..1 |
Type | id |
Summary | true |
Comments | 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. |
Profile.mapping | |
Definition | An external specification that the content is mapped to. |
Control | 0..* |
Invariants | Defined on this element prf-2: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
Profile.mapping.identity | |
Definition | An Internal id that is used to identify this mapping set when specific mappings are made. |
Control | 1..1 |
Type | id |
Comments | The specification is described once, with general comments, and then specific mappings are made that reference this declaration. |
Profile.mapping.uri | |
Definition | A URI that identifies the specification that this mapping is expressed to. |
Control | 0..1 |
Type | uri |
Comments | A formal identity for the specification being mapped to helps with identifying maps consistently. |
Invariants | Affect this element prf-2: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
Profile.mapping.name | |
Definition | A name for the specification that is being mapped to. |
Control | 0..1 |
Type | string |
Invariants | Affect this element prf-2: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
Profile.mapping.comments | |
Definition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
Control | 0..1 |
Type | string |
Profile.type | |
Definition | The Resource or Data type being described. |
Control | 1..1 |
Binding | FHIRDefinedType: Any defined Resource or Data Type name |
Type | code |
Comments | Only complex types can be constrained, not primitive types such as string etc. |
Profile.base | |
Definition | The structure that is the base on which this set of constraints is derived from. |
Control | 0..1 |
Type | uri |
Comments | 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. |
Profile.snapshot | |
Definition | A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base profile. |
Control | 0..1 |
Invariants | Defined on this element prf-1: Element paths must be unique - or not (LM) (xpath: count(f:element) >= count(distinct-values(f:element/f:path/@value))) prf-4: If a structure is a snapshot, then each element definition must have a formal definition, and cardinalities (xpath: exists(f:base) or (count(f:element) = count(f:element[exists(f:formal) and exists(f:min) and exists(f:max)]))) |
Profile.snapshot.element | |
Definition | Captures constraints on each element within the resource. |
Control | 0..* |
Type | ElementDefinition |
Profile.differential | |
Definition | A differential view is expressed relative to the base profile - a statement of differences that it applies. |
Control | 0..1 |
Type | See Profile.snapshot |