Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #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

Operation-specimendefinition-apply

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Apply

OPERATION: Apply

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/SpecimenDefinition-apply

The apply operation applies a SpecimenDefinition in a given context to create a Specimen resource instance

URL: [base]/SpecimenDefinition/$apply

URL: [base]/SpecimenDefinition/[id]/$apply

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

specimenDefinition

0..1

SpecimenDefinition

The specimen definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required

IN

subject

1..*

string
(reference)

The subject(s) that is/are the target of the Specimen instance to be created. The subject may be a Patient, Group, Device, Substance or Location. Subjects provided in this parameter will be resolved as the subject of the Specimen based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined

IN

collector

0..1

string
(reference)

The practitioner (or practitioner role) that is collecting the specimen

IN

userType

0..1

CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)

IN

userLanguage

0..1

CodeableConcept

Preferred language of the person using the system

IN

userTaskContext

0..1

CodeableConcept

The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources

IN

setting

0..1

CodeableConcept

The current setting of the request (inpatient, outpatient, etc.)

IN

settingContext

0..1

CodeableConcept

Additional detail about the setting of the request, if any

OUT

return

1..1

Specimen

The Specimen resource that is the result of applying the specimen definition

The result of this operation is a Specimen resource based on the definition of the specimen as described in the SpecimenDefinition resource and the supplied parameters.

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.