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

6.17.8 Resource Profile - Detailed Descriptions

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.

Control1..1
Alternate NamesTemplate
Comments

Often called a clinical template.

InvariantsDefined 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.

Control1..1
Typeuri
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 Namesurl; authoritative-url; destination
gForge Tasks3265
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).

Control0..1
TypeIdentifier
Summarytrue
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.

Control0..1
Typestring
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.

Summarytrue
Comments

N/A.

Profile.name
Definition

A free text natural language name identifying the Profile.

Control1..1
Typestring
Summarytrue
Comments

Not expected to be globally unique.

Profile.publisher
Definition

The name of the individual or organization that published the profile.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the profile. May also allow for contact.

Summarytrue
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.

Control0..*
Summarytrue
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.

Control0..1
Typestring
Summarytrue
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.

Control0..*
TypeContactPoint
Summarytrue
Profile.description
Definition

A free text natural language description of the profile and its use.

Control0..1
Typestring
Summarytrue
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.

Control0..*
TypeCoding
Requirements

Assist in searching for appropriate profiles.

Summarytrue
Profile.status
Definition

The status of the profile.

Control1..1
BindingResourceProfileStatus: Required: http://hl7.org/fhir/resource-profile-status (The lifecycle status of a Resource Profile)
Typecode
Is Modifiertrue
Requirements

Allows filtering of profiles that are appropriate for use vs. not.

Summarytrue
Profile.experimental
Definition

This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Requirements

Allows filtering of profiles that are appropriate for use vs. not.

Summarytrue
Profile.date
Definition

The date that this version of the profile was published.

Control0..1
TypedateTime
Summarytrue
Profile.requirements
Definition

The Scope and Usage that this profile was created to meet.

Control0..1
Typestring
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.

Control0..1
Typeid
Summarytrue
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.

Control0..*
InvariantsDefined 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.

Control1..1
Typeid
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.

Control0..1
Typeuri
Comments

A formal identity for the specification being mapped to helps with identifying maps consistently.

InvariantsAffect 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.

Control0..1
Typestring
InvariantsAffect 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.

Control0..1
Typestring
Profile.type
Definition

The Resource or Data type being described.

Control1..1
BindingFHIRDefinedType: Any defined Resource or Data Type name
Typecode
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.

Control0..1
Typeuri
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.

Control0..1
InvariantsDefined 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.

Control0..*
TypeElementDefinition
Profile.differential
Definition

A differential view is expressed relative to the base profile - a statement of differences that it applies.

Control0..1
TypeSee Profile.snapshot