OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

BiologicallyDerivedProductDispenseBased-onSearchParam

The order or request that this dispense is fulfilling

BiologicallyDerivedProductDispenseIdentifierSearchParam

The identifier of the dispense

BiologicallyDerivedProductDispensePart-ofSearchParam

Part of referenced event

BiologicallyDerivedProductDispensePatientSearchParam

The identity of a patient for whom to list dispenses

BiologicallyDerivedProductDispensePerformerSearchParam

Who performed the action

BiologicallyDerivedProductDispenseProductSearchParam

Search for products that match this code

BiologicallyDerivedProductDispenseStatusSearchParam

The status of the dispense

BiologicallyDerivedProductDispenseSubjectSearchParam

The intended recipient(s) of the dispensed product

DeviceDispenseCodeSearchParam

Search for devices that match this code

DeviceDispenseIdentifierSearchParam

The identifier of the dispense

DeviceDispensePatientSearchParam

Returns device dispenses for a specific patient

DeviceDispenseStatusSearchParam

The status of the dispense

DeviceDispenseSubjectSearchParam

The identity of a patient for whom to list dispenses

DeviceUsageBody-structure-codeSearchParam

Code for target body structure

DeviceUsageDeviceSearchParam

Search by device

DeviceUsageIdentifierSearchParam

Search by identifier

DeviceUsagePatientSearchParam

Search by patient who used the device

DeviceUsageReferenceSearchParam

Target body structure (reference)

DeviceUsageStatusSearchParam

The status of the device usage

DeviceUsageSubjectSearchParam

The individual(s) who used the device

InventoryItemCodeSearchParam

Search for products that match this code

InventoryItemIdentifierSearchParam

The identifier of the item

InventoryItemStatusSearchParam

The status of the item

InventoryItemSubjectSearchParam

The identity of a patient for whom to list associations

InventoryReportIdentifierSearchParam

Search by identifier

InventoryReportItem-referenceSearchParam

Search by items in inventory report

InventoryReportItemSearchParam

Search by items in inventory report

InventoryReportStatusSearchParam

Search by status

SupplyDeliveryIdentifierSearchParam

External identifier

SupplyDeliveryPatientSearchParam

Patient for whom the item is supplied

SupplyDeliveryReceiverSearchParam

Who collected the Supply

SupplyDeliveryStatusSearchParam
in-progress completed abandoned entered-in-error
SupplyDeliverySubjectSearchParam

Individual(s) or organization for whom the item is supplied

SupplyDeliverySupplierSearchParam

Dispenser

SupplyRequestCategorySearchParam

The kind of supply (central, non-stock, etc.)

SupplyRequestDateSearchParam

When the request was made

SupplyRequestIdentifierSearchParam

Business Identifier for SupplyRequest

SupplyRequestPatientSearchParam

The patient or subject for whom the supply is destined

SupplyRequestReplacesSearchParam

What request replaces

SupplyRequestRequesterSearchParam

Individual making the request

SupplyRequestStatusSearchParam
draft active suspended +
SupplyRequestSubjectSearchParam

The destination of the supply

SupplyRequestSupplierSearchParam

Who is intended to fulfill the request

TransportIdentifierSearchParam

External identifier

TransportPatientSearchParam

Search by subject - a patient

TransportStatusSearchParam
in-progress completed entered-in-error
TransportSubjectSearchParam

Search for subject

Structures: Additional Resources

'Additional' resources that are not yet published in the FHIR core specification.

BiologicallyDerivedProductDispense

A record of dispensation of a biologically derived product.

DeviceDispense

Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.

DeviceUsage

A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.

InventoryItem

functional description of an inventory item used in inventory and supply-related workflows.

InventoryReport

A report of inventory or stock items.

SupplyDelivery

Record of delivery of what is supplied.

SupplyRequest

A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived product, and nutrition product used in the healthcare setting.

Transport

Record of transport.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

MedicalProductOfHumanOrigin

This profile is designed for biologically derived products that are derived from a human donor and intended for clinical application in a human recipient. Donor and recipient might, or might not, be the same individual. Products of this nature are referred to as medical products of human origin (MPHO) and have specific traceability requirements to ensure that the bi-directional link between donor and recipient is maintained. The profile specifies the essential identifiers for traceability as required elements.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Biologically Derived Product Dispense Match Status

Biologically Derived Product Dispense Match Status.

Biologically Derived Product Dispense Origin Relationship

Biologically Derived Product Dispense Origin Relationship.

Biologically Derived Product Dispense Performer Function

Biologically Derived Product Dispense Performer Function.

Biologically Derived Product Dispense Status

Biologically Derived Product Dispense Status Codes.

Device Usage Adherence Code

A coded concept indicating the adherence of device usage.

Device Usage Adherence Reason

A coded concept indicating the adherence of device usage.

Device Usage Status

A coded concept indicating the current status of the Device Usage.

DeviceDispense Status Reason Value Set

DeviceDispense Status Reason Codes

DeviceDispense Status Value Set

Value set to describe the device dispense status.

Inventory Count Type

The type of count.

Inventory Report Status

The status of the InventoryReport.

InventoryItem Name Typess

InventoryItem Name Types

InventoryItem Status Codes

InventoryItem Status Codes

SNOMED CT Supply Item

This value set includes SNOMED CT where concept is-a 105590001 (Substance (substance)) or concept is-a 260787004 (Physical object) and provided as an example value set.

Supply Delivery Stage

Stage of the supply delivery.

Supply Delivery Status

Status of the supply delivery.

Supply Delivery Supply Item Condition

This value sets refers to the condition of a specific supply item.

Supply Delivery Supply Item Type

This value sets refers to a specific supply item.

Supply Request Reason

The reason why the supply item was requested.

Supply Request Status

Status of the supply request.

Supply Request When

Example codes indicating the timing of when the request should be (is intended to be) fulfilled.

Supply Type

This value sets refers to a Category of supply.

Transport Codes

Codes indicating the type of action that is expected to be performed

Transport Intent Value Set

Distinguishes whether the transport is a proposal, plan or full order.

Transport Reason Codes

Example ValueSet that can be used to describe reasons for transport.

Transport Status Reason Value Set

Status reason of the transport.

Transport Status Value Set

Status of the transport

Transport Type Value Set

This value sets refers to a specific supply item.

Transport Value Set

Codes indicating the type of action that is expected to be performed

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Biologically Derived Product Dispense Match Status

Biologically Derived Product Dispense Match Status

Biologically Derived Product Dispense Origin Relationship

Biologically Derived Product Dispense Origin Relationship

Biologically Derived Product Dispense Performer Function

Biologically Derived Product Dispense Performer Function

Biologically Derived Product Dispense Status Codes

Biologically Derived Product Dispense Status Codes

Device Usage Adherence Code

A coded concept indicating the usage of the device.

Device Usage Adherence Reason

A coded concept indicating the reason for the usage of the device.

Device Usage Status

A coded concept indicating the current status of the Device Usage.

DeviceDispense Status Code System

DeviceDispense Status

DeviceDispense Status Reason Code System

DeviceDispense Status Reason Codes

Inventory Count Type

The type of count.

Inventory Report Status

The status of the InventoryReport.

InventoryItem Name Type

InventoryItem Name Type

InventoryItem Status Codes

InventoryItem Status Codes

Supply Delivery Stage

Stage of the supply delivery.

Supply Delivery Status

Status of the supply delivery.

Supply Delivery Supply Item Condition

Status of the supply delivery.

Supply Delivery Supply Item Type

Status of the supply delivery.

Supply Request Status

Status of the supply request.

Transport Code

Example codes for transport events demonstrating different types of transport activities

Transport Code System

Example codes for transport events demonstrating different types of transport activities

Transport Intent Code System

Distinguishes whether the transport is a proposal, plan or full order.

Transport Status Code System

Status of transport.

Transport Status Reason Code System

Status of transport.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

BiologicallyDerivedProductDispense example

An example BiologicallyDerivedProductDispense resource

DeviceDispense example

An example DeviceDispense resource

DeviceUsage example

An example DeviceUsage resource

InventoryItem example

An example InventoryItem resource

InventoryReport example

An example InventoryReport resource

SupplyDelivery blood product delivery (ISBT128) example

An example SupplyDelivery resource for a blood product (ISBT128) delivery

SupplyDelivery blood product delivery example

An example SupplyDelivery resource for a blood product delivery

SupplyDelivery pump delivery example

An example SupplyDelivery resource for a pump delivery

SupplyDelivery simple delivery example

An example SupplyDelivery resource for a simple delivery

SupplyRequest simple order example

An example SupplyRequest resource for a simple order

SupplyRequest-example
Transport simple delivery example

An example Transport resource for a simple delivery

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

BiologicallyDerivedProductDispense-examples
BiologicallyDerivedProductDispense-operations
City Hospital Lab Location

Physical Location of Example City Hospital Lab

DeviceDispense-examples
DeviceDispense-operations
DeviceUsage-examples
DeviceUsage-operations
InventoryItem-examples
InventoryItem-operations
InventoryReport-examples
InventoryReport-operations
Lab A Location

Physical Location of Example Lab A

SupplyDelivery-examples
SupplyDelivery-operations
SupplyRequest-examples
SupplyRequest-operations
Transport-examples
Transport-operations