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.9.4 StructureDefinition: GAO Diagnostic Order - Detailed Descriptions

Definitions for the gao-diagnosticorder Profile.

DiagnosticOrder
Definition

A record of a request for a diagnostic investigation service to be performed.

Control0..*
TypeDiagnosticOrder
DiagnosticOrder.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.

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

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

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

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

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

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

DiagnosticOrder.identifier
Definition

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

Control0..*
TypeIdentifier
Comments

The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the notes section below.

DiagnosticOrder.status
Definition

The status of the order.

Control0..1
BindingThe status of a diagnostic order.
The codes SHALL be taken from DiagnosticOrderStatus
Typecode
Is Modifiertrue
Comments

Typically the system placing the order sets the status to "requested". Thereafter, the order is maintained by the receiver that updates the status as the request is handled.

DiagnosticOrder.priority
Definition

The clinical priority associated with this order.

Control0..1
BindingThe clinical priority of a diagnostic order.
The codes SHALL be taken from DiagnosticOrderPriority
Typecode
Comments

The Order resource also has a priority. Generally, these should be the same, but they can be different. For instance, where the clinician indicates the order is urgent, but the subsequent workflow process overrules the priority for some reason. The effective default value is "normal".

DiagnosticOrder.subject
Definition

On whom or what the investigation is to be performed. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

Control1..1
TypeChoice of: Reference(Patient), Reference(Group), Reference(Location), Reference(Device)
DiagnosticOrder.encounter
Definition

An encounter that provides additional information about the healthcare context in which this request is made.

Control0..1
TypeReference(Encounter)
DiagnosticOrder.orderer
Definition

The practitioner that holds legal responsibility for ordering the investigation.

Control0..1
TypeReference(Practitioner)
DiagnosticOrder.reason
Definition

An explanation or justification for why this diagnostic investigation is being requested. This is often for billing purposes. May relate to the resources referred to in supportingInformation.

Control0..*
BindingDiagnosis or problem codes justifying the reason for requesting the diagnostic investigation.
For example codes, see Condition/Problem/Diagnosis Codes
TypeCodeableConcept
Comments

This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all. Use CodeableConcept text element if the data is free (uncoded) text as shown in the CT Scan example.

DiagnosticOrder.supportingInformation
Definition

Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order.

Control0..*
TypeChoice of: Reference(Observation), Reference(Condition), Reference(DocumentReference)
Must Supporttrue
Requirements

Supporting information SHALL be provided if known. This field may be required to facilitate evaluation of appropriateness. The supportingInformation field assists with interpretation of the results, and is not intended to provide the reason or indication for the order (see reason[x] above in the Order resource).

Alternate NamesAsk at order entry question, AOE
Comments

This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". Examples include reporting the amount of inspired oxygen for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations.

DiagnosticOrder.specimen
Definition

One or more specimens that the diagnostic investigation is about.

Control0..*
TypeReference(Specimen)
Comments

Many investigation requests will create a need for specimens, but the request itself is not actually about the specimens. This is provided for when the diagnostic investigation is requested on already existing specimens.

DiagnosticOrder.event
Definition

A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed.

Control0..*
TypeBackboneElement
Comments

This is not the same as an audit trail. It is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.

DiagnosticOrder.event.id
Definition

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

Control0..1
Typeid
DiagnosticOrder.event.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.

DiagnosticOrder.event.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.

DiagnosticOrder.event.status
Definition

The status for the event.

Control1..1
BindingThe status of a diagnostic order.
The codes SHALL be taken from DiagnosticOrderStatus
Typecode
DiagnosticOrder.event.description
Definition

Additional information about the event that occurred - e.g. if the status remained unchanged.

Control0..1
BindingAdditional information about an event that occurred to a diagnostic order - e.g. if the status remained unchanged.
For example codes, see Diagnostic Order Event Codes
TypeCodeableConcept
DiagnosticOrder.event.dateTime
Definition

The date/time at which the event occurred.

Control1..1
TypedateTime
DiagnosticOrder.event.actor
Definition

The person responsible for performing or recording the action.

Control0..1
TypeChoice of: Reference(Practitioner), Reference(Device)
DiagnosticOrder.item
Definition

The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.

Control1..*
TypeBackboneElement
Requirements

At least one item SHALL be present in the order to describe the service being performed.

Comments

There would always be at least one item in normal usage, but this is optional so that a workflow can quote order details without having to list the items.

DiagnosticOrder.item.id
Definition

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

Control0..1
Typeid
DiagnosticOrder.item.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.

DiagnosticOrder.item.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.

DiagnosticOrder.item.code
Definition

A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.

Control1..1
BindingCodes for tests/services that can be performed by diagnostic services.
The codes SHOULD be taken from LOINC Diagnostic Order Codes
TypeCodeableConcept
Comments

Many laboratory tests and radiology tests embed the specimen/organ system in the test name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code.

DiagnosticOrder.item.specimen
Definition

If the item is related to a specific specimen.

Control0..*
TypeReference(Specimen)
Comments

A single specimen should not appear in both DiagnosticOrder.specimen and DiagnosticOrder.item.specimen.

DiagnosticOrder.item.bodySite
Definition

Anatomical location where the request test should be performed. This is the target site.

Control0..1
BindingCodes describing anatomical locations. May include laterality.
For example codes, see SNOMED CT Body Structures
TypeCodeableConcept
Must Supporttrue
Requirements

The body site SHALL be provided when relevant to the order (e.g., MRI of upper joint, where the location is the shoulder or elbow and the laterality is left or right).

Alternate Nameslocation
Comments

If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension body-site-instance.

DiagnosticOrder.item.status
Definition

The status of this individual item within the order.

Control0..1
BindingThe status of a diagnostic order.
The codes SHALL be taken from DiagnosticOrderStatus
Typecode
Comments

If the request has multiple items that have their own life cycles, then the items will have their own status while the overall diagnostic order is (usually) "in-progress".

DiagnosticOrder.item.event
Definition

A summary of the events of interest that have occurred as this item of the request is processed.

Control0..*
TypeSee event
DiagnosticOrder.note
Definition

Any other notes associated with this patient, specimen or order (e.g. "patient hates needles").

Control0..*
TypeAnnotation
Must Supporttrue
Requirements

Sometimes a text justification must be provided instead of coded and structured data. This field must be supported and SHALL be provided if known.