This page is part of the FHIR Specification (v0.01: Historical Archive Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

# Profile

A Resource Profile - a statement of constraint on one or more Resources and/or Concept Domains.

The relative url is /profiles

## Content

    <Profile xmlns="http://www.hl7.org/fhir">
      <id> mand id fixed identifier for this profile (UUID)</id>
      <name> mand string Informal name for this profile</name>
      <author> mand  <!-- (Organisation or individual) -->
       <name> mand string Name of the recognised author</name>
       <reference> opt Zero+ uri Web reference to the author</reference>
      </author>
      <intention> opt string Why this profile was written</intention>
      <code> opt Zero+ Coding assist with indexing and finding</code>
      <description> mand string natural language description of the Template</description>
      <evidence> opt Zero+ uri Supporting evidence for the design</evidence>
      <comments> opt string Guidance for use, usage notes, etc</comments>
      <status> mand code draft | testing | production | withdrawn | superceded</status>
      <date> mand dateTime date for given status</date>
      <endorser> opt  <!-- Zero+ (Organisation or individual) -->
       <name> mand string Name of the recognised endorser</name>
       <reference> opt uri Web reference to the endorser</reference>
      </endorser>
      <changes> cond string notes about changes since last version</changes>
      <supercedes> opt Zero+ uri references to previous versions</supercedes>
      <profile> opt Zero+ uri other profiles that apply (i.e. code binding rules)</profile>
      <resource> mand Zero+ Constraint Resource Type with constraints</resource>
      <binding> mand  <!-- Zero+ -->
       <name> mand string concept domain name</name>
       <type> mand code binding type</type>
       <details> cond string extra details - see notes</details>
       <reference> cond uri source of binding content</reference>
       <code> cond Zero+ Coding enumerated codes that are the binding</code>
      </binding>
      <extensions> opt See Extensions   See Extensions </extensions>
      <text> mand Narrative Text summary of resource profile for human interpretation</text>
    </Profile>

Schema for Profile and an example (or formatted for browser)

Terminology Bindings

- Profile.status is bound to the concept domain ResourceProfileStatus: "The lifecycle status of a Resource Profile". Possible values:

  draft | This profile is still under development
  testing | this profile was authored for testing purposes (or education/evaluation/evangelisation)
  production | This profile is ready for use in production systems
  withdrawn | This profile has been withdrawn
  superceded | This profile was superceded by a more recent version

- Profile.binding.type is bound to the concept domain ConceptBindingType: "The type of a binding for a concept domain". Possible values:

  Unbound | The concept domain is not bound to anything
  CodeList | The concept domain is bound to a list of supplied codes - only those codes are allowed
  Reference | The concept domain references some external definition by a provided reference
  Preferred | The concept domain references a set of preferred terms
  Suggestion | This profile was superceded by a more recent version
  External | The concept domain is defined by an external authority identified in the reference

Notes:

- The name of the profile is not required to be globally unique, but the name should have some scoping information (i.e. Acme Inc (USA), Allergy List)
- Multiple codes may be assigned to the profile. These may either describe the template, or the focus of the template, or both. They are solely to help find the profile by searching for structured concepts
- If other profiles are referenced, then any constraints in those profiles also apply to this profile. If a resource or binding is found in this profile, the constraints described must include all the constraints found in the referenced profiles, so that it is not necessary to search the referenced profiles and merge the constraints. The primary use of referencing other profiles is to re-use concept binding constraints

## Searching Criteria

The following simple search/filter parameters are defined for Resource Profiles:

name | a portion of the name of the resource
author | name or id of the author
code | a code in the format uri::code
status | a status of the profile
type | type of resource that is constrained in the profile
domain | concept domain that is constrained in the resource

The standard search parameters also apply (see Searching).

## Formal Definitions

The formal definitions for the elements above. Also available as an XML file

Profile
Definition | A Resource Profile - a statement of constraint on one or more Resources and/or Concept Domains
Control | Mandatory, 1..1
Comments | Often called a clinical template
Profile.id
Definition | Globally unique Profile Id (Must be a UUID)
Control | Mandatory, 1..1
Type | id
Must Understand | true
Profile.name
Definition | A free text natural language name identifying the Template.
Control | Mandatory, 1..1
Type | string
Comments | Not expected to be unique
Profile.author
Definition | Details of the author who accepts responsibility for publishing the profile
Control | Mandatory, 1..1
Comments | Usually an organisation, but may be an individual
Profile.author.name
Definition | The name of the author
Control | Mandatory, 1..1
Type | string
Profile.author.reference
Definition | Reference to the author to assist a user in finding and communicating with the author
Control | Optional, 0..*
Type | uri
Comments | may be a web site, an email address, a telephone number
Profile.intention
Definition | A free text natural language description of the intent and scope of the Template. The purpose is to provide the authorâ€™s initial intent for the Template in the language specified below.
Control | Optional, 0..1
Type | string
Profile.code
Definition | A set of terms from a controlled reference terminology that may be used to assist with indexing and searching of templates
Control | Optional, 0..*
Type | Coding
Profile.description
Definition | A free text natural language description of the Template. Generally, this field should be used for things such as goals, variable lists, instructions for clinical use and interpretation, literature, examples from paper world, mapping from natural language to HL7 and the model itself, etc
Control | Mandatory, 1..1
Type | string
Profile.evidence
Definition | A description, reference or link to a published medical knowledge that was used in the definition of this Template
Control | Optional, 0..*
Type | uri
Profile.comments
Definition | A statement regarding when this Template should not be used, or may be used erroneously. To define roles where the Template should not be used, or should be used with care. This field is used to expand in detail on the iIntention
Control | Optional, 0..1
Type | string
Profile.status
Definition | draft | testing | production | withdrawn | superceded
Control | Mandatory, 1..1
Type | code from ResourceProfileStatus
Must Understand | true
Profile.date
Definition | The date that the current value for publicationStatus was applied to the Template
Control | Mandatory, 1..1
Type | dateTime
Profile.endorser
Definition | A list of bodies who have reviewed the Template for clinical accuracy and relevance, and endorsed it for use.
Control | Optional, 0..*
Profile.endorser.name
Definition | The name of the endorsing body
Control | Mandatory, 1..1
Type | string
Profile.endorser.reference
Definition | Reference to the author to assist a user in finding and communicating with the endorsing body
Control | Optional, 0..1
Type | uri
Profile.changes
Definition | A free text description describing the changes in this version of the profile as compared to the previous version.
Control | Conditional, 0..1: This field must be populated if the template is not the first version.
Type | string
Profile.supercedes
Definition | A template that is supercded by this template (maybe a previous version)
Control | Optional, 0..*
Type | uri
Profile.profile
Definition | Additional other profiles that apply to this conformance statement.
Control | Optional, 0..*
Type | uri
Comments | Generally these profiles make constraints on the bindings of concept domains / value sets
Profile.resource
Definition | Resource Type with constraints
Control | Mandatory, 0..*
Type | Constraint
Profile.binding
Control | Mandatory, 0..*
Profile.binding.name
Definition | The name of the concept domain that this profile is declaring a constraint on
Control | Mandatory, 1..1
Type | string
Profile.binding.type
Definition | The form of the binding
Control | Mandatory, 1..1
Type | code from ConceptBindingType
Profile.binding.details
Definition | extra details - see notes
Control | Conditional, 0..1: May be required depending on the value of binding.type
Type | string
Profile.binding.reference
Definition | source of binding content
Control | Conditional, 0..1: May be required depending on the value of binding.type
Type | uri
Profile.binding.code
Definition | enumerated codes that are the binding
Control | Conditional, 0..*: May be required depending on the value of binding.type
Type | Coding
Profile.extensions
Definition | See Extensions
Control | Optional, 0..1
Profile.text
Definition | Text summary of resource profile for human interpretation
Control | Mandatory, 1..1
Type | Narrative

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.01 generated on Mon, May 14, 2012 09:48+1000.