[go: up one dir, main page]

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

FHIR Infrastructure icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Not Classified Compartments: Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the Basic resource.

Basic
Element IdBasic
Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Short DisplayResource for non-supported content
Cardinality0..*
TypeDomainResource
Requirements

Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.

Alternate NamesZ-resource; Extension-resource; Custom-resource
Summaryfalse
Basic.identifier
Element IdBasic.identifier
Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Basic.code
Element IdBasic.code
Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Short DisplayKind of Resource
Cardinality1..1
Terminology BindingBasic Resource Types (Example)
TypeCodeableConcept
Is Modifiertrue (Reason: This element determines what kind of resource is being represented which drives the meaning of all of the other elements.)
Requirements

Must be able to distinguish different types of Basic resources.

Summarytrue
Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Basic.subject
Element IdBasic.subject
Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

Short DisplayIdentifies the focus of this resource
Cardinality0..1
TypeReference(Any)
Requirements

Needed for partitioning the resource by Patient.

Summarytrue
Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Basic.created
Element IdBasic.created
Definition

Identifies when the resource was first created.

Short DisplayWhen created
Cardinality0..1
TypedateTime
Requirements

Allows ordering resource instances by time.

Summarytrue
Basic.author
Element IdBasic.author
Definition

Indicates who was responsible for creating the resource instance.

Short DisplayWho created
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization | Device | CareTeam)
Requirements

Needed for partitioning the resource.

Summarytrue