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 US Laboratory Diagnostic Order Profile - Definitions

Todo

Definitions for the do-uslab-uslabdo Profile.

DiagnosticOrder(USLabDO)
Definition

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

Control1..1
Requirements
Alternate NamesDO
Comments
DiagnosticOrder.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.

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

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

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.

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

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

DiagnosticOrder.text.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.text.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.

DiagnosticOrder.text.status
Definition

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Control1..1
BindingThe status of a resource narrative
The codes SHALL be taken from NarrativeStatus
Typecode
Must Supporttrue
Requirements
Comments
Fixed Valuegenerated
DiagnosticOrder.text.div
Definition

The actual narrative content, a stripped down version of XHTML.

Control1..1
Typexhtml
Requirements
Comments

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

InvariantsDefined on this element
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (xpath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]))
txt-2: The narrative SHALL have some non-whitespace content (xpath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src])
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (xpath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))]))
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
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.

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
DiagnosticOrder.extension (http://hl7.org/fhir/ExtensionDefinition/uslabcc-practitioner)
Definition

Non-ordering practitioner, to whom the orderer instructs the recipient to send the results of the request.

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

create type for each resource.

DiagnosticOrder.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.extension.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.

DiagnosticOrder.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Requirements
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

DiagnosticOrder.extension.valueReference
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/pract-uslab-uslabpract))
Must Supporttrue
Requirements
Comments
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
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.

DiagnosticOrder.subject
Definition

Who or what the investigation is to be performed on. 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(Profile = (Profile = http://hl7.org/fhir/Profile/patient-uslab-uslabpatient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/patient-uslab-uslabphpatient))
Must Supporttrue
Requirements
Alternate NamesPatient
Comments
DiagnosticOrder.orderer
Definition

The practitioner that holds legal responsibility for ordering the investigation.

Control1..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/pract-uslab-uslabphpract)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/pract-uslab-uslabpract))
Must Supporttrue
Requirements
Alternate NamesOrdering Provider, OP, Submitter, Placer
Comments
DiagnosticOrder.identifier
Definition

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

Control0..*
TypeIdentifier
Requirements
Comments
SlicingThis element introduces a set of slices. The slicing rules are:
  • ordered
  • closed
  • discriminators: identifier.label
DiagnosticOrder.identifier(USLabDOPlacerID)
Definition

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

Control1..1
TypeIdentifier
Must Supporttrue
Requirements
Alternate NamesPlacer ID
Comments
DiagnosticOrder.identifier.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.identifier.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.

DiagnosticOrder.identifier.use
Definition

The purpose of this identifier.

Control1..1
BindingIdentifies the purpose for this identifier, if known
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Fixed Valueofficial
DiagnosticOrder.identifier.label
Definition

A text string for the identifier that can be displayed to a human so they can recognize the identifier.

Control1..1
Typestring
Must Supporttrue
Requirements

Allows humans to make use of identifiers when the identifier system is not known.

Comments
Fixed ValuePlacer Order Number
DiagnosticOrder.identifier.system
Definition

Placer URI.

Control1..1
Typeuri
Must Supporttrue
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
DiagnosticOrder.identifier.value
Definition

Placer Identifier.

Control1..1
Typestring
Must Supporttrue
Requirements
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example123456
DiagnosticOrder.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Requirements
Comments
DiagnosticOrder.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments

The reference may be just a text description of the assigner.

DiagnosticOrder.identifier(USLabDOFillerID)
Definition

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

Control0..1
TypeIdentifier
Must Supporttrue
Requirements
Alternate NamesFiller ID
Comments
DiagnosticOrder.identifier.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.identifier.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.

DiagnosticOrder.identifier.use
Definition

The purpose of this identifier.

Control1..1
BindingIdentifies the purpose for this identifier, if known
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Fixed Valueofficial
DiagnosticOrder.identifier.label
Definition

A text string for the identifier that can be displayed to a human so they can recognize the identifier.

Control1..1
Typestring
Must Supporttrue
Requirements

Allows humans to make use of identifiers when the identifier system is not known.

Comments
Fixed ValueFiller Order Number
DiagnosticOrder.identifier.system
Definition

Filler URI.

Control1..1
Typeuri
Must Supporttrue
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
DiagnosticOrder.identifier.value
Definition

Filler Identifier.

Control1..1
Typestring
Must Supporttrue
Requirements
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example123456
DiagnosticOrder.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Requirements
Comments
DiagnosticOrder.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments

The reference may be just a text description of the assigner.

DiagnosticOrder.encounter
Definition

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

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Encounter))
Requirements
Comments
DiagnosticOrder.clinicalNotes
Definition

An explanation or justification for why this diagnostic investigation is being requested.

Control0..1
Typestring
Must Supporttrue
Requirements
Comments

This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all.

DiagnosticOrder.supportingInformation
Definition

Additional clinical information about the patient or specimen that may influence test interpretations.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/obs-uslab-uslabobscode)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/obs-uslab-uslabobsquantity)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/obs-uslab-uslabobsother)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/obs-uslab-uslabobsratio)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/cond-uslab-uslabcond)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/DocumentReference))
Must Supporttrue
Requirements
Alternate NamesAOE, Reason for Study
Comments

This information includes diagnosis, clinical findings and other observations. Examples include reporting the amount of inspired carbon dioxide 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(Profile = (Profile = http://hl7.org/fhir/Profile/spec-uslab-uslabspec))
Must Supporttrue
Requirements
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.status
Definition

The status of the order.

Control1..1
BindingThe status of a diagnostic order
The codes SHALL be taken from DiagnosticOrderStatus
Typecode
Must Supporttrue
Requirements
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.

Control1..1
BindingThe clinical priority of a diagnostic order
The codes SHALL be taken from DiagnosticOrderPriority
Typecode
Must Supporttrue
Requirements
Comments

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

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.

Control1..*
Must Supporttrue
Requirements
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
Requirements
Comments
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
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.

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

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
Requirements
Comments
DiagnosticOrder.event.description
Definition

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

Control1..1
BindingInformation about an event that occurred to a diagnostic order that corresponds to the USLabOrder Use Cases
The codes SHALL be taken from USLAB Diagnostic Order Event Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements
Comments
DiagnosticOrder.event.description.id
Definition

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

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

DiagnosticOrder.event.description.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

DiagnosticOrder.event.description.coding.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.event.description.coding.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.

DiagnosticOrder.event.description.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

DiagnosticOrder.event.description.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

DiagnosticOrder.event.description.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
DiagnosticOrder.event.description.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
DiagnosticOrder.event.description.coding.primary
Definition

Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

DiagnosticOrder.event.description.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
DiagnosticOrder.event.description.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

DiagnosticOrder.event.dateTime
Definition

The date/time at which the event occurred.

Control1..1
TypedateTime
Must Supporttrue
Requirements
Comments
InvariantsDefined on this element
inv-2: Datetime must be at least to day. (xpath: f:matches(dateTime,/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/))
DiagnosticOrder.event.actor
Definition

The person who was responsible for performing or recording the action.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device))
Requirements
Comments
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..*
Must Supporttrue
Requirements
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
Requirements
Comments
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
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.

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

DiagnosticOrder.item.code
Definition

The laboratory test, panel or battery that was ordered.

Control1..1
BindingCodes for tests/services that can be performed by diagnostic services
The codes SHOULD be taken from LOINC Diagnostic Order Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements
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.

InvariantsDefined on this element
inv-1: Must have a LOINC or a Local code or both. (xpath: exists(f:coding))
DiagnosticOrder.item.code.id
Definition

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

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

DiagnosticOrder.item.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: system
DiagnosticOrder.item.code.coding(USLabLOINCCoding)
Definition

LOINC coding if available.

Control0..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Alternate NamesLOINC code
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

DiagnosticOrder.item.code.coding.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.item.code.coding.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.

DiagnosticOrder.item.code.coding.system
Definition

LOINC Coding System.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
DiagnosticOrder.item.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

DiagnosticOrder.item.code.coding.code
Definition

Logical Observation Identifiers Names and Codes (LOINC) is a database and universal standard for identifying medical laboratory observations.

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
DiagnosticOrder.item.code.coding.display
Definition

The LOINC 'long common name' is preferred although the LOINC 'short name' or the LOINC 'fully-specified name can also be used. ( http://lionc.org.terms-of-use).

Control0..1
Typestring
Must Supporttrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
DiagnosticOrder.item.code.coding.primary
Definition

Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

DiagnosticOrder.item.code.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
DiagnosticOrder.item.code.coding(USLabLocalCoding)
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Alternate NamesLocal
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

DiagnosticOrder.item.code.coding.id
Definition

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

Control0..1
Typeid
Requirements
Comments
DiagnosticOrder.item.code.coding.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.

DiagnosticOrder.item.code.coding.system
Definition

This is defined locally.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

DiagnosticOrder.item.code.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
Typestring
Requirements
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

DiagnosticOrder.item.code.coding.code
Definition

Local Code.

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments
DiagnosticOrder.item.code.coding.display
Definition

This is defined locally.

Control0..1
Typestring
Must Supporttrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
DiagnosticOrder.item.code.coding.primary
Definition

Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations.

DiagnosticOrder.item.code.coding.valueSet
Definition

The set of possible coded values this coding was chosen from or constrained by.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Requirements

The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare.

Comments
DiagnosticOrder.item.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Must Supporttrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

DiagnosticOrder.item.specimen
Definition

If the item is related to a specific specimen.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/spec-uslab-uslabspec))
Must Supporttrue
Requirements
Comments

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

DiagnosticOrder.item.bodySite[x]
Definition

Anatomical location where the request test should be performed.

Control0..0
BindingCodes describing anatomical locations. May include laterality
For example codes, see SNOMED CT Body Structures
TypeChoice of: CodeableConcept, Reference(Profile = (Profile = http://hl7.org/fhir/Profile/BodySite))
Requirements
Alternate Nameslocation
Comments
DiagnosticOrder.item.status
Definition

The status of this individual item within the order.

Control1..1
BindingThe status of a diagnostic order
The codes SHALL be taken from DiagnosticOrderStatus
Typecode
Must Supporttrue
Requirements
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
Requirements
Comments