FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure iconMaturity Level: 1Informative

Detailed Descriptions for the elements in the Definition pattern.

Definition
Definition

A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.

Short DisplayDefinition Pattern
Cardinality0..*
TypeLogical
Definition.url
Definition

An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

Short DisplayCanonical identifier for this {{title}}, represented as an absolute URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the {{title}} to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http/s: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Definition.identifier
Definition

A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short DisplayBusiness identifier for {{title}}
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.

Definition.version
Definition

The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short DisplayBusiness version of the {{title}}
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different {{title}}s that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Definition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Definition.name
Definition

A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short DisplayName for this {{title}} (computer friendly)
Cardinality0..1
Typestring
Requirements

Supports code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.

Definition.title
Definition

A short, descriptive, user-friendly title for the {{title}}.

Short DisplayName for this {{title}} (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Definition.derivedFromCanonical
Definition

The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.

Short DisplayBased on FHIR protocol or definition
Cardinality0..*
Typecanonical(Definition[ActivityDefinition, ChargeItemDefinition, ClinicalUseDefinition, EventDefinition, Measure, MessageDefinition, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SubscriptionTopic, TestPlan, TestScript])
Requirements

Protocols and order sets may be refinements of more generic protocols and order sets.

Summarytrue
Definition.derivedFromUri
Definition

The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.

Short DisplayBased on external protocol or definition
Cardinality0..*
Typeuri
Requirements

Protocols and order sets may be refinements of more generic protocols and order sets.

Summarytrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Definition.partOf
Definition

A larger definition of which this particular definition is a component or step.

Short DisplayPart of referenced definition
Cardinality0..*
Typecanonical(Definition[ActivityDefinition, ChargeItemDefinition, ClinicalUseDefinition, EventDefinition, Measure, MessageDefinition, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SubscriptionTopic, TestPlan, TestScript])
Requirements

E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

Alternate Namescontainer
Summarytrue
Comments

[The allowed reference resources may be adjusted as appropriate for the event resource].

Definition.status
Definition

The current state of this {{title}}.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Requirements

Enables tracking the lifecycle of the content and filtering of {{title}}s that are appropriate for use versus not.

Summarytrue
Comments

A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

To DoShould this be a common code system for all definitions?
Definition.experimental
Definition

A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.

Summarytrue
Comments

Allows filtering of {{title}}s that are appropriate for use versus not.

Definition.subject
Definition

A code or group definition that describes the intended subject of instantiations of this definition.

Short DisplayType of individual the defined service is for
Cardinality0..*
Terminology BindingDefinitionSubject:
TypeCodeableReference(Group)
Requirements

Many protocols, order sets and guidelines are intended for use only with specific types of patients or subjects.

Alternate NamesSubject type
Summarytrue
Definition.date
Definition

The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate Namescreated
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Definition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.

Alternate Namesauthor
Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context.

Definition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

Definition.description
Definition

A free text natural language description of the {{title}} from a consumer's perspective.

Short DisplayNatural language description of the {{title}}
Cardinality0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.

Definition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Definition.jurisdiction
Definition

A legal or geographic region in which the {{title}} is intended to be used.

Short DisplayIntended jurisdiction for {{title}} (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.).

Definition.purpose
Definition

Explanation of why this {{title}} is needed and why it has been designed as it has.

Short DisplayWhy this {{title}} is defined
Cardinality0..1
Typemarkdown
Comments

This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.

Definition.copyright
Definition

A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers of the {{title}} must be able to determine any legal restrictions on the use of the artifact and/or its content.

Alternate NamesLicense; Restrictions
Definition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Definition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the {{title}} was approved by publisher
Cardinality0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Definition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the {{title}} was last reviewed
Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

Definition.effectivePeriod
Definition

The period during which the {{title}} content was or is planned to be in active use.

Short DisplayWhen the {{title}} is expected to be used
Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the {{title}} are or are expected to be used instead.

Summarytrue
Comments

The effective period for a {{title}} determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Definition.topic
Definition

Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches.

Short DisplayDescriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching
Cardinality0..*
TypeCodeableConcept
Requirements

This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element.

Summarytrue
Definition.performerType
Definition

The type of individual that is expected to act upon instances of this definition.

Short DisplayDesired kind of service performer
Cardinality0..1
Terminology BindingPerformerType:
TypeCodeableConcept
Summarytrue
To DoNeed to define who.performer.
Definition.code
Definition

A code that identifies the specific service or action that was or is being performed.

Short DisplayService to be done
Cardinality0..1
TypeCodeableConcept
Alternate Namestype
Summarytrue
Definition.product
Definition

Indicates the product supplied or manipulated by this {{title}}.

Short DisplayProduct to use/manipulate
Cardinality0..1
TypeCodeableReference(BiologicallyDerivedProduct | DeviceDefinition | Medication | NutritionProduct | Substance)
Summarytrue