Order Catalog Implementation Guide
1.0.0 - STU 1

Order Catalog Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: LabServiceDefinition Profile ( Experimental )

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition | Version: 1.0.0
Standards status: Informative | Computable Name: LabServiceDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.55.42.18

The LabServiceDefinition profile constrains the PlanDefinition resource to represent a laboratory diagnostic service for the clinicians using such services. Clinicians typically order laboratory services and use the results thereof in the course of their delivery of clinical care.

A laboratory diagnostic service is a kind of clinical artifact that falls within the scope of PlanDefinition. It involves preparation of the patient, collection and delivery to the lab of biological/digital specimens , tests and panels performed on these specimens, interpretation of the results by the pathologist, and delivery of the results and diagnostic report back to the ordering clinician and possibly other recipients, including the patient. PlanDefinition conveys the general properties of the lab service. It describes the usage of the service, the contexts and situations in which this service is useful, and may also detail the goals that the laboratory service contributes to, such as screening or diagnostic of a particular pathology, monitoring of a long course treatment …

An instance of PlanDefintion, thus, represents a laboratory service. It references one or more instances of ActivityDefinition, describing the service in terms of laboratory procedures, with their input and output observations. The PlanDefinition also references the instances of SpecimenDefinition representing the kinds of specimens needed to perform the service.

A service may be a panel or super-panel grouping other laboratory services that may also be ordered independently. In that case, the PlanDefinition of the encompassing service references the PlanDefinition resources representing the included services (relatedArtifact, type composed-of).

Reflex tests are represented as sub-actions grouped in a logical group with behavior any, meaning that any number of members of the group may be performed. Each sub-action is associated with a trigger conveying the named event, which reflexes it.

A definition of a laboratory diagnostic service conforming to this profile can be used in a laboratory compendium/catalog as well as in other contexts.

A laboratory service is fulfilled through the execution of one or more laboratory procedures. The logical combinations of these procedures may be conjunctions (execute each of them) or disjunctions (execute at most one of them), or a mixture of both logical structures. The closest resource that may represent a service as a set of activities logically combined with this flexibility is PlanDefinition. PlanDefinition is therefore selected to represent a laboratory service, and the laboratory procedures needed to achieve this service are represented by instances of ActivityDefinition referenced by PlanDefinition, from logical groups defined in PlanDefinition.

Usages:

- Refer to this Profile: Laboratory Service Definition
- Examples for this Profile: BloodElectrolytePanel, UrineCreatinineClearancePanel, UrineCreatininePanel, CMVIgM... Show 9 more, HSVIgMserum, HVS1IgMtiter, HVS2IgMtiter, PotassiumSerumMeasurement, RubellaIgM, TORCH, Toxoplasmagondii, VitaminDMeasurement and SerumCreatinineTest
- CapabilityStatements using this Profile: CapabilityStatement for custodian of catalog of laboratory in vitro diagnostic services

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions Constraints: cnl-0, pld-3, pld-4
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
type | S Σ | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
description | Σ | 0..1 | markdown | Natural language description of the plan definition
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
Slices for useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S Σ | 0..1 | UsageContext | Service is orderable
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:PathologistInitiative | S Σ | 0..1 | UsageContext | Service may be added by pathologist
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:OneGender | S Σ | 0..1 | UsageContext | service restricted to one gender
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S Σ | 0..1 | UsageContext | Specimens to be kept
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:AgeRange | S Σ | 0..* | UsageContext | A patient age range applicable for this service
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | Range | patient age range applicable for this service Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
topic | S | 0..* | CodeableConcept | categorization of the laboratory service Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: depends-on
label | Σ | 1..1 | string | Name of the kind of document expected
display | Σ | 1..1 | string | Brief description of the related artifact
document | Σ | 0..1 | Attachment | Document model
url | Σ | 0..1 | url | url of the model of document expected Example General: http://www.acme.com/logo-small.png
title | Σ | 0..1 | string | Title of the kind or model of document Example General: Official Corporate Logo
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: successor
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
type | Σ | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
action | C | 1..1 | BackboneElement | Action defined by the plan
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code of the laboratory service Binding: ActionCode (example): Provides examples of actions to be performed.
Slices for coding | Σ | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory service
system | S Σ | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
type | Σ C | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Required Pattern: named-event
name | Σ C | 1..1 | string | Name or URI that identifies the event
timing[x] | Σ C | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ C | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. Required Pattern: logical-group
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:Orderable.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:Orderable.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:PathologistInitiative.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:PathologistInitiative.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:OneGender.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.useContext:StoreSpecimen.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:StoreSpecimen.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:AgeRange.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:AgeRange.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG
PlanDefinition.action.​priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​code | Base | example | Action Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​trigger:Reflex.type | Base | required | TriggerType | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | Action Grouping Behavior | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition | `%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()`
pld-4 | warning | PlanDefinition | targetId should reference the id of an action | `%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()`

This structure is derived from PlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
title |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Synonym in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
type | S | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
description |  | 0..1 | markdown | Natural language description of the plan definition
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S | 0..1 | UsageContext | Service is orderable
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:PathologistInitiative | S | 0..1 | UsageContext | Service may be added by pathologist
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:OneGender | S | 0..1 | UsageContext | service restricted to one gender
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S | 0..1 | UsageContext | Specimens to be kept
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:AgeRange | S | 0..* | UsageContext | A patient age range applicable for this service
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
value[x] |  | 1..1 | Range | patient age range applicable for this service
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
topic | S | 0..* | CodeableConcept | categorization of the laboratory service
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: depends-on
label |  | 1..1 | string | Name of the kind of document expected
display |  | 1..1 | string | Brief description of the related artifact
document |  | 0..1 | Attachment | Document model
url |  | 0..1 | url | url of the model of document expected
title |  | 0..1 | string | Title of the kind or model of document
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: successor
resource |  | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: composed-of
resource |  | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
type |  | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
action |  | 1..1 | BackboneElement | Action defined by the plan
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
priority |  | 0..1 | code | routine | urgent | asap | stat
code | S | 0..1 | CodeableConcept | Code of the laboratory service
Slices for coding |  | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S | 0..1 | Coding | LOINC code for the laboratory service
system | S | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
type |  | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Required Pattern: named-event
name |  | 1..1 | string | Name or URI that identifies the event
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Required Pattern: logical-group
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions Constraints: cnl-0, pld-3, pld-4
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) Constraints: cnl-1
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition
version | Σ | 0..1 | string | Business version of the plan definition
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this plan definition (computer friendly)
title | Σ | 0..1 | string | Name for this plan definition (human friendly)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Synonym in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
subtitle |  | 0..1 | string | Subordinate title of the plan definition
type | S Σ | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
subject[x] |  | 0..1 |  | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) |
subjectCanonical |  |  | canonical(EvidenceVariable) |
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 0..1 | markdown | Natural language description of the plan definition
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | markdown | Primitive value for markdown
Slices for useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S Σ | 0..1 | UsageContext | Service is orderable
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:PathologistInitiative | S Σ | 0..1 | UsageContext | Service may be added by pathologist
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:OneGender | S Σ | 0..1 | UsageContext | service restricted to one gender
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S Σ | 0..1 | UsageContext | Specimens to be kept
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:AgeRange | S Σ | 0..* | UsageContext | A patient age range applicable for this service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | Range | patient age range applicable for this service Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this plan definition is defined
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
approvalDate |  | 0..1 | date | When the plan definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the plan definition was last reviewed by the publisher
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used
topic | S | 0..* | CodeableConcept | categorization of the laboratory service Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: depends-on
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 1..1 | string | Name of the kind of document expected
display | Σ | 1..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | Document model
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | Σ C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Additional Bindings | Purpose
CommonLanguages | Starter
Example General: en-AU
data | C | 0..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | url of the model of document expected Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | integer64 | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Title of the kind or model of document Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
height |  | 0..1 | positiveInt | Height of the image in pixels (photo/video)
width |  | 0..1 | positiveInt | Width of the image in pixels (photo/video)
frames |  | 0..1 | positiveInt | Number of frames if > 1 (photo)
duration |  | 0..1 | decimal | Length in seconds (audio / video)
pages |  | 0..1 | positiveInt | Number of printed pages
resource | Σ | 0..1 | canonical(Resource) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: successor
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 0..1 | canonical(Resource) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
library |  | 0..* | canonical(Library) | Logic used by the plan definition
goal | C | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
category |  | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
priority |  | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
start |  | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses |  | 0..* | CodeableConcept | What does the goal address Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the goal
target |  | 0..* | BackboneElement | Target outcome for the goal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
measure |  | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x] |  | 0..1 |  | The target value to be achieved
detailQuantity |  |  | Quantity |
detailRange |  |  | Range |
detailCodeableConcept |  |  | CodeableConcept |
detailString |  |  | string |
detailBoolean |  |  | boolean |
detailInteger |  |  | integer |
detailRatio |  |  | Ratio |
due |  | 0..1 | Duration | Reach goal within
actor |  | 0..* | BackboneElement | Actors within the plan
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
description |  | 0..1 | markdown | Describes the actor
option |  | 1..* | BackboneElement | Who or what can be this actor
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example)
action | C | 1..1 | BackboneElement | Action defined by the plan
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
linkId |  | 0..1 | string | Unique id for the action in the PlanDefinition
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
textEquivalent |  | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code of the laboratory service Binding: ActionCode (example): Provides examples of actions to be performed.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 0..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId | C | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
subjectCanonical |  |  | canonical(Any) |
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ C | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Required Pattern: named-event
name | Σ C | 1..1 | string | Name or URI that identifies the event
code | Σ | 0..1 | CodeableConcept | Coded definition of the event
subscriptionTopic | Σ | 0..1 | canonical(SubscriptionTopic) | What event
timing[x] | Σ C | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ C | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ C | 0..1 | Expression | Whether the event triggers (boolean expression)
condition |  | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | C | 0..* | BackboneElement | Input data requirements Constraints: pld-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
requirement | C | 0..1 | DataRequirement | What data is provided
relatedData | C | 0..1 | id | What data is provided
output | C | 0..* | BackboneElement | Output data definition Constraints: pld-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
requirement | C | 0..1 | DataRequirement | What data is provided
relatedData | C | 0..1 | string | What data is provided
relatedAction | C | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
targetId | C | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
endRelationship |  | 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingAge |  |  | Age |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
location |  | 0..1 | CodeableReference(Location) | Where it should happen
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actorId |  | 0..1 | string | What actor
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action.
function |  | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example)
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. Required Pattern: logical-group
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
PlanDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std.
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:Orderable.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:Orderable.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:PathologistInitiative.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:PathologistInitiative.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:OneGender.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.useContext:StoreSpecimen.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:StoreSpecimen.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:AgeRange.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:AgeRange.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​document.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​document.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG
PlanDefinition.relatedArtifact:Bibliography.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal Category | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal Priority | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std.
PlanDefinition.actor.​option.type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
PlanDefinition.actor.​option.role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
PlanDefinition.action.​priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​code | Base | example | Action Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​reason | Base | example | Action Reason Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​trigger:Reflex.type | Base | required | TriggerType | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | Action Condition Kind | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​relatedAction.endRelationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
PlanDefinition.action.​participant.function | Base | example | Action Participant Function | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | Action Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | Action Grouping Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | Action Selection Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | Action Required Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | Action Precheck Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | Action Cardinality Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pld-0 | error | PlanDefinition.action.input | Input data elements must have a requirement or a relatedData, but not both | `requirement.exists() xor relatedData.exists()`
pld-1 | error | PlanDefinition.action.output | Output data element must have a requirement or a relatedData, but not both | `requirement.exists() xor relatedData.exists()`
pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition | `%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()`
pld-4 | warning | PlanDefinition | targetId should reference the id of an action | `%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()`

This structure is derived from PlanDefinition

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 20 elements

Structures

This structure refers to these other structures:

- Laboratory Service Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition)
- Laboratory Procedure Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
- http://hl7.org/fhir/StructureDefinition/translation
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested

Slices

This structure defines the following Slices:

- The element 3 is sliced based on the values of PlanDefinition.useContext
- The element 1 is sliced based on the value of PlanDefinition.relatedArtifact
- The element 1 is sliced based on the value of PlanDefinition.action.code.coding
- The element 1 is sliced based on the value of PlanDefinition.action.trigger

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions Constraints: cnl-0, pld-3, pld-4
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
type | S Σ | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
description | Σ | 0..1 | markdown | Natural language description of the plan definition
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
Slices for useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S Σ | 0..1 | UsageContext | Service is orderable
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:PathologistInitiative | S Σ | 0..1 | UsageContext | Service may be added by pathologist
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:OneGender | S Σ | 0..1 | UsageContext | service restricted to one gender
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S Σ | 0..1 | UsageContext | Specimens to be kept
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:AgeRange | S Σ | 0..* | UsageContext | A patient age range applicable for this service
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | Range | patient age range applicable for this service Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
topic | S | 0..* | CodeableConcept | categorization of the laboratory service Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: depends-on
label | Σ | 1..1 | string | Name of the kind of document expected
display | Σ | 1..1 | string | Brief description of the related artifact
document | Σ | 0..1 | Attachment | Document model
url | Σ | 0..1 | url | url of the model of document expected Example General: http://www.acme.com/logo-small.png
title | Σ | 0..1 | string | Title of the kind or model of document Example General: Official Corporate Logo
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: successor
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
type | Σ | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
action | C | 1..1 | BackboneElement | Action defined by the plan
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code of the laboratory service Binding: ActionCode (example): Provides examples of actions to be performed.
Slices for coding | Σ | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory service
system | S Σ | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
type | Σ C | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Required Pattern: named-event
name | Σ C | 1..1 | string | Name or URI that identifies the event
timing[x] | Σ C | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ C | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. Required Pattern: logical-group
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:Orderable.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:Orderable.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:PathologistInitiative.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:PathologistInitiative.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:OneGender.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.useContext:StoreSpecimen.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:StoreSpecimen.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:AgeRange.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:AgeRange.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG
PlanDefinition.action.​priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​code | Base | example | Action Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​trigger:Reflex.type | Base | required | TriggerType | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | Action Grouping Behavior | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition | `%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()`
pld-4 | warning | PlanDefinition | targetId should reference the id of an action | `%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()`

Differential View

This structure is derived from PlanDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
title |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Synonym in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
type | S | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
description |  | 0..1 | markdown | Natural language description of the plan definition
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
Slices for useContext | S | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S | 0..1 | UsageContext | Service is orderable
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:PathologistInitiative | S | 0..1 | UsageContext | Service may be added by pathologist
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:OneGender | S | 0..1 | UsageContext | service restricted to one gender
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S | 0..1 | UsageContext | Specimens to be kept
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
value[x] |  | 1..1 | CodeableConcept | Value that defines the context Required Pattern: At least the following
useContext:AgeRange | S | 0..* | UsageContext | A patient age range applicable for this service
code |  | 1..1 | Coding | Type of context being specified Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
value[x] |  | 1..1 | Range | patient age range applicable for this service
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
topic | S | 0..* | CodeableConcept | categorization of the laboratory service
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: depends-on
label |  | 1..1 | string | Name of the kind of document expected
display |  | 1..1 | string | Brief description of the related artifact
document |  | 0..1 | Attachment | Document model
url |  | 0..1 | url | url of the model of document expected
title |  | 0..1 | string | Title of the kind or model of document
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: successor
resource |  | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
type |  | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Required Pattern: composed-of
resource |  | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
type |  | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
action |  | 1..1 | BackboneElement | Action defined by the plan
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
priority |  | 0..1 | code | routine | urgent | asap | stat
code | S | 0..1 | CodeableConcept | Code of the laboratory service
Slices for coding |  | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S | 0..1 | Coding | LOINC code for the laboratory service
system | S | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
type |  | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Required Pattern: named-event
name |  | 1..1 | string | Name or URI that identifies the event
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Required Pattern: logical-group
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions Constraints: cnl-0, pld-3, pld-4
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:CatalogReference |  | 0..* | Reference(Catalog Header) | Reference to a catalog exposing this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
extension:ServiceBillingCode |  | 0..* | CodeableConcept | A billing code associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
extension:BillingSummary |  | 0..1 | (Complex) | Textual summary of billing applied to the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
extension:ScheduleSummary |  | 0..1 | string | Textual summary of the schedule of the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
extension:LimitationSummary |  | 0..1 | string | Textual summary of limitations associated with the service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
extension:RegulatorySummary |  | 0..1 | string | Textual summary of regulations applicable to this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
extension:ResultInterpretationSummary |  | 0..1 | markdown | markdown summary of result interpretation guidance for this service URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) Constraints: cnl-1
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition
version | Σ | 0..1 | string | Business version of the plan definition
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this plan definition (computer friendly)
title | Σ | 0..1 | string | Name for this plan definition (human friendly)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Synonym in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
subtitle |  | 0..1 | string | Subordinate title of the plan definition
type | S Σ | 0..1 | CodeableConcept | panel | test Binding: Types of diagnostic services performed by a laboratory (extensible)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
subject[x] |  | 0..1 |  | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) |
subjectCanonical |  |  | canonical(EvidenceVariable) |
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 0..1 | markdown | Natural language description of the plan definition
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherDescription |  | 0..* | (Complex) | Translation in a specified language URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | markdown | Primitive value for markdown
Slices for useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code, type:value, value:value
useContext:Orderable | S Σ | 0..1 | UsageContext | Service is orderable
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:PathologistInitiative | S Σ | 0..1 | UsageContext | Service may be added by pathologist
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:OneGender | S Σ | 0..1 | UsageContext | service restricted to one gender
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: AdministrativeGender (required)
useContext:StoreSpecimen | S Σ | 0..1 | UsageContext | Specimens to be kept
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: task
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: At least the following
useContext:AgeRange | S Σ | 0..* | UsageContext | A patient age range applicable for this service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
value[x] | Σ | 1..1 | Range | patient age range applicable for this service Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this plan definition is defined
usage | S | 0..1 | markdown | Describes the clinical usage of the laboratory diagnostic service
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
approvalDate |  | 0..1 | date | When the plan definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the plan definition was last reviewed by the publisher
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used
topic | S | 0..* | CodeableConcept | categorization of the laboratory service Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations Slice: Unordered, Open by value:type
relatedArtifact:InputDocumentExpected | S | 0..* | RelatedArtifact | Input document expected by the laboratory service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: depends-on
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 1..1 | string | Name of the kind of document expected
display | Σ | 1..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | Document model
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | Σ C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Additional Bindings | Purpose
CommonLanguages | Starter
Example General: en-AU
data | C | 0..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | url of the model of document expected Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | integer64 | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Title of the kind or model of document Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
height |  | 0..1 | positiveInt | Height of the image in pixels (photo/video)
width |  | 0..1 | positiveInt | Width of the image in pixels (photo/video)
frames |  | 0..1 | positiveInt | Number of frames if > 1 (photo)
duration |  | 0..1 | decimal | Length in seconds (audio / video)
pages |  | 0..1 | positiveInt | Number of printed pages
resource | Σ | 0..1 | canonical(Resource) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:IsReplacedBy | S | 0..* | RelatedArtifact | Reference to a service replacing the current non-usable one
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: successor
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:Includes | S | 0..* | RelatedArtifact | Reference to a panel or test included by the current one
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 1..1 | canonical(Laboratory Service Definition) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
relatedArtifact:Bibliography | S | 0..* | RelatedArtifact | Additional documentation, citation or justification
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ | 1..1 | code | documentation | justification | citation Binding: Types of bibliographic artifacts (required)
classifier | Σ | 0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
label | Σ | 0..1 | string | Short label
display | Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
document | Σ | 0..1 | Attachment | What document is being referenced
resource | Σ | 0..1 | canonical(Resource) | What artifact is being referenced
resourceReference | Σ | 0..1 | Reference(Resource) | What artifact, if not a conformance resource
publicationStatus | Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to.
publicationDate | Σ | 0..1 | date | Date of publication of the artifact being referred to
library |  | 0..* | canonical(Library) | Logic used by the plan definition
goal | C | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
category |  | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
description |  | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
priority |  | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
start |  | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
addresses |  | 0..* | CodeableConcept | What does the goal address Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the goal
target |  | 0..* | BackboneElement | Target outcome for the goal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
measure |  | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
detail[x] |  | 0..1 |  | The target value to be achieved
detailQuantity |  |  | Quantity |
detailRange |  |  | Range |
detailCodeableConcept |  |  | CodeableConcept |
detailString |  |  | string |
detailBoolean |  |  | boolean |
detailInteger |  |  | integer |
detailRatio |  |  | Ratio |
due |  | 0..1 | Duration | Reach goal within
actor |  | 0..* | BackboneElement | Actors within the plan
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
description |  | 0..1 | markdown | Describes the actor
option |  | 1..* | BackboneElement | Who or what can be this actor
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example)
action | C | 1..1 | BackboneElement | Action defined by the plan
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:SpecimenRequested |  | 0..* | (Complex) | Specimens required for this action URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
linkId |  | 0..1 | string | Unique id for the action in the PlanDefinition
prefix |  | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
title |  | 0..1 | string | User-visible title
description |  | 0..1 | markdown | Brief description of the laboratory service and its method
textEquivalent |  | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | S | 0..1 | CodeableConcept | Code of the laboratory service Binding: ActionCode (example): Provides examples of actions to be performed.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code for the laboratory service Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory service
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | LOINC code system Required Pattern: http://loinc.org
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 0..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
reason |  | 0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
documentation |  | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
goalId | C | 0..* | id | What goals this action supports
subject[x] |  | 0..1 |  | Type of individual the action is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
subjectCanonical |  |  | canonical(Any) |
Slices for trigger | S | 0..* | TriggerDefinition | When the action should be triggered Slice: Unordered, Open by value:type
trigger:Reflex | S | 0..* | TriggerDefinition | Reflex laboratory procedure
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | Σ C | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Required Pattern: named-event
name | Σ C | 1..1 | string | Name or URI that identifies the event
code | Σ | 0..1 | CodeableConcept | Coded definition of the event
subscriptionTopic | Σ | 0..1 | canonical(SubscriptionTopic) | What event
timing[x] | Σ C | 0..1 |  | Timing of the event
timingTiming |  |  | Timing |
timingReference |  |  | Reference(Schedule) |
timingDate |  |  | date |
timingDateTime |  |  | dateTime |
data | Σ C | 0..* | DataRequirement | Triggering data of the event (multiple = 'and')
condition | Σ C | 0..1 | Expression | Whether the event triggers (boolean expression)
condition |  | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression |  | 0..1 | Expression | Boolean-valued expression
input | C | 0..* | BackboneElement | Input data requirements Constraints: pld-0
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
requirement | C | 0..1 | DataRequirement | What data is provided
relatedData | C | 0..1 | id | What data is provided
output | C | 0..* | BackboneElement | Output data definition Constraints: pld-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
title |  | 0..1 | string | User-visible title
requirement | C | 0..1 | DataRequirement | What data is provided
relatedData | C | 0..1 | string | What data is provided
relatedAction | C | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
targetId | C | 1..1 | id | What action is this related to
relationship |  | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
endRelationship |  | 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x] |  | 0..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingAge |  |  | Age |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
location |  | 0..1 | CodeableReference(Location) | Where it should happen
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actorId |  | 0..1 | string | What actor
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action.
function |  | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example)
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. Required Pattern: logical-group
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
definition[x] | S | 0..1 | canonical(Laboratory Procedure Definition) | Description of the activity to be performed
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 0..1 | string | The path to the element to be set dynamically
expression |  | 0..1 | Expression | An expression that provides the dynamic value for the customization
action |  | 0..* | See action (PlanDefinition) | A sub-action
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PlanDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
PlanDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std.
PlanDefinition.type | Base | extensible | Types of diagnostic services performed by a laboratory | 📦1.0.0 | This IG
PlanDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:Orderable.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:Orderable.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:PathologistInitiative.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:PathologistInitiative.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:OneGender.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:OneGender.​value[x] | Base | required | AdministrativeGender | 📦5.0.0 | FHIR Std.
PlanDefinition.useContext:StoreSpecimen.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:StoreSpecimen.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.useContext:AgeRange.​code | Base | extensible | UsageContextType | 📦1.0.1 | THO v7.1
PlanDefinition.useContext:AgeRange.​value[x] | Base | example | Context of Use ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std.
PlanDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​document.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​document.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:InputDocumentExpected.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:IsReplacedBy.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​type | Base | required | RelatedArtifactType | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Includes.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​type | Base | required | Types of bibliographic artifacts | 📦1.0.0 | This IG
PlanDefinition.relatedArtifact:Bibliography.​classifier | Base | example | Citation Artifact Classifier | 📍5.0.0 | FHIR Std.
PlanDefinition.relatedArtifact:Bibliography.​publicationStatus | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​category | Base | example | Goal Category | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​description | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​priority | Base | preferred | Goal Priority | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​start | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std.
PlanDefinition.goal.​target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std.
PlanDefinition.actor.​option.type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
PlanDefinition.actor.​option.role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
PlanDefinition.action.​priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​code | Base | example | Action Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​reason | Base | example | Action Reason Code | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​trigger:Reflex.type | Base | required | TriggerType | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​condition.kind | Base | required | Action Condition Kind | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​relatedAction.relationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​relatedAction.endRelationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​participant.type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​participant.role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
PlanDefinition.action.​participant.function | Base | example | Action Participant Function | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​type | Base | extensible | Action Type | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​groupingBehavior | Base | required | Action Grouping Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​selectionBehavior | Base | required | Action Selection Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​requiredBehavior | Base | required | Action Required Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​precheckBehavior | Base | required | Action Precheck Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.action.​cardinalityBehavior | Base | required | Action Cardinality Behavior | 📍5.0.0 | FHIR Std.
PlanDefinition.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pld-0 | error | PlanDefinition.action.input | Input data elements must have a requirement or a relatedData, but not both | `requirement.exists() xor relatedData.exists()`
pld-1 | error | PlanDefinition.action.output | Output data element must have a requirement or a relatedData, but not both | `requirement.exists() xor relatedData.exists()`
pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition | `%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()`
pld-4 | warning | PlanDefinition | targetId should reference the id of an action | `%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()`

This structure is derived from PlanDefinition

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 20 elements

Structures

This structure refers to these other structures:

- Laboratory Service Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition)
- Laboratory Procedure Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
- http://hl7.org/fhir/StructureDefinition/translation
- http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested

Slices

This structure defines the following Slices:

- The element 3 is sliced based on the values of PlanDefinition.useContext
- The element 1 is sliced based on the value of PlanDefinition.relatedArtifact
- The element 1 is sliced based on the value of PlanDefinition.action.code.coding
- The element 1 is sliced based on the value of PlanDefinition.action.trigger

Other representations of profile: CSV, Excel, Schematron