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

Profile CCDA Non-Medicinal Supply Activity - Definitions

Todo

Definitions for the supply-ccda-nonmedsupplyactivity-ccdanonmedsupplyactivity Profile.

Supply(CCDANonMedSupplyActivity)
Definition

A supply - a request for something, and provision of what is supplied.

Control1..1
Requirements
Comments
Supply.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
Requirements
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.

Supply.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
Requirements
Comments
Supply.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
Requirements
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.

Supply.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
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).

Supply.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Supply.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Requirements
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Supply.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Supply.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Supply.kind
Definition

Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.

Control0..1
BindingCategory of supply
The codes SHOULD be taken from Supply Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements
Comments
Supply.identifier
Definition

Unique identifier for this supply request.

Control0..1
TypeIdentifier
Requirements
Comments

This is assigned by the orderer, and used to refer to this order in other external standards.

Supply.status
Definition

Status of the supply request.

Control1..1
BindingStatus of the supply
The codes SHALL be taken from SupplyStatus
Typecode
Is Modifiertrue
Requirements
Comments
Fixed Valuedispensed
Supply.orderedItem
Definition

The item that is requested to be supplied.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Medication)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Substance)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device))
Requirements
Comments

Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.

Supply.patient
Definition

A link to a resource representing the person whom the ordered item is for.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Supply.dispense
Definition

Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.

Control0..*
Requirements
Comments
Supply.dispense.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Supply.dispense.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Supply.dispense.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Supply.dispense.identifier
Definition

Identifier assigned by the dispensing facility when the item(s) is dispensed.

Control0..1
TypeIdentifier
Requirements
Comments

This is assigned by the dispenser, and used to refer to this order in other external standards.

Supply.dispense.status
Definition

A code specifying the state of the dispense event.

Control0..1
BindingStatus of the dispense
The codes SHALL be taken from SupplyDispenseStatus
Typecode
Is Modifiertrue
Requirements
Comments
Supply.dispense.type
Definition

Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

Control0..1
BindingThe actual item being supplied
The codes SHOULD be taken from Supply Item Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements
Comments
Supply.dispense.quantity
Definition

The amount of supply that has been dispensed. Includes unit of measure.

Control0..1
TypeQuantity
Requirements
Comments
Supply.dispense.suppliedItem
Definition

Identifies the medication or substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Medication)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Substance)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device))
Requirements
Comments
Supply.dispense.supplier
Definition

The individual responsible for dispensing the medication, supplier or device.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner))
Requirements
Comments
Supply.dispense.whenPrepared
Definition

The time the dispense event occurred.

Control0..1
TypePeriod
Requirements
Comments
Supply.dispense.whenHandedOver
Definition

The time the dispensed item was sent or handed to the patient (or agent).

Control0..1
TypedateTime
Requirements
Comments
Supply.dispense.destination
Definition

Identification of the facility/location where the Supply was shipped to, as part of the dispense event.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Location))
Requirements
Comments
Supply.dispense.receiver
Definition

Identifies the person who picked up the Supply.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner))
Requirements
Comments