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 . Page versions: R5 R4B R4 R3 R2

1.13.1.5 Resource - Detailed Descriptions

Detailed Descriptions for the elements in the Base Resource Definitions.

Resource
Definition

Base Resource for everything.

Control1..1
Resource.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Resource.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Resource.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Resource.language
Definition

The base language in which the resource is written.

Control0..1
BindingLanguage: Required: IETF language tag (A human language)
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control1..1
Meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the url. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Meta.deleted
Definition

Set to 'true' if the resource is deleted. Deleted resources can not be fetched via the RESTful API, but may appear in bundles for various reasons.

Control0..1
Typeboolean
Default Valuefalse
Meaning if MissingNot deleted
Meta.profile
Definition

A list of profiles that this resource claims to conform to. The URL is a reference to Profile.url.

Control0..*
Typeuri
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over tiem.

Meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource.

Meta.tag
Definition

Tags applied to this resource. Tags are intended to to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
TypeCoding
Comments

The tags can be updated without changing the stated version of the resource.