STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

K.5.4 StructureDefinition: Guideline Appropriate Order - Detailed Descriptions

Definitions for the gao-order Profile.

Order
Definition

A request to perform an action.

Control0..*
TypeOrder
Alternate NamesRequest
Order.id
Definition

The logical id of the resource, as used in the URL for the resource. 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.

Order.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
Order.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.

Order.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
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).

Order.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
Alternate Namesnarrative, html, xhtml, display
Comments

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

Order.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
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.

Order.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
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.

Order.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
Is Modifiertrue
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.

Order.identifier
Definition

Identifiers assigned to this order by the orderer or by the receiver.

Control1..1
TypeIdentifier
Requirements

The placer order identifier is provided so that the receiver of the evaluation can verify that the order being placed was the same as an order that was authorized.

Comments

The placer order identifier associated with the order shall be provided.

Order.date
Definition

When the order was made.

Control1..1
TypedateTime
Requirements

The date of the order is provided so that the receiver of the evaluation can verify that the order was produced within a reasonable time period for accepting the evaluation according to local policies, and to enable the Decision Support Service to apply relevant guidelines. The value shall be precise to the day.

Comments

The date associated with the order SHALL be provided.

Order.subject
Definition

Patient this order is about.

Control1..1
TypeReference(GAO Patient)
Requirements

The patient is provided so that relevant demographics, such as age and gender can be used to evaluate appropriateness.

Alternate NamesPatient
Comments

The patient for whom the order is being placed SHALL be provided.

Order.source
Definition

Who initiated the order.

Control1..1
TypeReference(GAO Practitioner)
Requirements

The identifier of the provider is provided in order for the receiver of the evaluation to verify that the evaluation given is associated with the correct order.

Alternate NamesAuthor, Practitioner
Comments

The identifier of the provider SHALL be provided.

Order.target
Definition

Who is intended to fulfill the order.

Control0..1
TypeChoice of: Reference(Organization), Reference(Device), Reference(Practitioner)
Order.reason[x]
Definition

Text - why the order was made.

Control1..1
BindingIndicates the reason for seeking fulfillment of the order.
TypeChoice of: CodeableConcept, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

The reason is required to support evaluation of the appropriateness of the order.

Comments

This field contains either a code or a contained resource that gives the reason (a.k.a. indication) for the order. This could include screening, signs or symptoms, diagnoses, diagnostic results, medications or procedures , or other resources. This information must be supported and SHALL be provided.

Order.when
Definition

When order should be fulfilled.

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ord-1: Provide a code or a schedule, but not both (xpath: exists(f:code) != exists(f:schedule))
Order.when.id
Definition

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

Control0..1
Typeid
Order.when.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
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.

Order.when.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
Is Modifiertrue
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.

Order.when.code
Definition

Code specifies when request should be done. The code may simply be a priority code.

Control0..1 This element is affected by the following invariants: ord-1
BindingWhen a requested action should be performed (e.g. STAT, daily, evenings, etc.).
TypeCodeableConcept
Comments

This is usually a local code agreed in the context of the ordering workflow.

Order.when.schedule
Definition

A formal schedule.

Control0..1 This element is affected by the following invariants: ord-1
TypeTiming
Order.detail
Definition

What action is being ordered.

Control1..1
TypeChoice of: Reference(GAO Diagnostic Order), Reference(GAO Medication Order), Reference(GAO Procedure Request), Reference(GAO Referral Request)
Requirements

The service being provided must be described so that the order can be evaluated for appropriateness. Only one order can be evaluated at a time.

Comments

The details of the order (e.g., service performed) SHALL be provided in order to evaluate them for appropriateness.