Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

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

Resource Profile: LabServiceDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: LabServiceDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.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.

Usage:

Formal Views of Profile Content

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

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... 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 pattern:code, type:value, pattern: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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender 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 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange 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 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
Fixed Value: 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 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
Fixed Value: successor
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Includes 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
Fixed Value: composed-of
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Bibliography 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
Fixed Value: http://loinc.org
.... Slices for trigger S 0..* TriggerDefinition When the action should be triggered
Slice: Unordered, Open by value:type
..... trigger:Reflex 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
Fixed Value: named-event
...... name 1..1 string Name or URI that identifies the event
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Fixed Value: logical-group
.... definition[x] S 0..1 canonical(Laboratory Procedure Definition) Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3: goalid should reference the id of a goal definition
pld-4: targetId should reference the id of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:CatalogReference 0..* Reference(Catalog Header) Reference to a catalog exposing this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ServiceBillingCode 0..* CodeableConcept A billing code associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:BillingSummary 0..1 (Complex) Textual summary of billing applied to the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ScheduleSummary 0..1 string Textual summary of the schedule of the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:LimitationSummary 0..1 string Textual summary of limitations associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:RegulatorySummary 0..1 string Textual summary of regulations applicable to this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ResultInterpretationSummary 0..1 markdown markdown summary of result interpretation guidance for this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... type SΣ 0..1 CodeableConcept panel | test
Binding: Types of diagnostic services performed by a laboratory (extensible)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... description Σ 0..1 markdown Natural language description of the plan definition
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:OtherDescription 0..* (Complex) Translation in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for useContext SΣ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code, type:value, pattern:value
ele-1: All FHIR elements must have a @value or children
.... useContext:Orderable SΣ 0..1 UsageContext Service is orderable
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative Σ 0..1 UsageContext Service may be added by pathologist
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender Σ 0..1 UsageContext service restricted to one gender
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
.... useContext:StoreSpecimen Σ 0..1 UsageContext Specimens to be kept
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange Σ 0..* UsageContext A patient age range applicable for this service
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
... usage S 0..1 markdown Describes the clinical usage of the laboratory diagnostic service
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept categorization of the laboratory service
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


ele-1: All FHIR elements must have a @value or children
... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:InputDocumentExpected 0..* RelatedArtifact Input document expected by the laboratory service
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: depends-on
..... label Σ 1..1 string Name of the kind of document expected
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Brief description of the related artifact
ele-1: All FHIR elements must have a @value or children
..... document Σ 0..1 Attachment Document model
ele-1: All FHIR elements must have a @value or children
...... url Σ 0..1 url url of the model of document expected
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Title of the kind or model of document
ele-1: All FHIR elements must have a @value or children
Example General: Official Corporate Logo
.... relatedArtifact:IsReplacedBy 0..* RelatedArtifact Reference to a service replacing the current non-usable one
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: successor
..... resource Σ 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:Includes 0..* RelatedArtifact Reference to a panel or test included by the current one
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: composed-of
..... resource Σ 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:Bibliography 0..* RelatedArtifact Additional documentation, citation or justification
ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 code documentation | justification | citation
Binding: Types of bibliographic artifacts (required)
ele-1: All FHIR elements must have a @value or children
... action C 1..1 BackboneElement Action defined by the plan
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:SpecimenRequested 0..* (Complex) Specimens required for this action
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... description 0..1 markdown Brief description of the laboratory service and its method
ele-1: All FHIR elements must have a @value or children
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.


ele-1: All FHIR elements must have a @value or children
.... code S 0..1 CodeableConcept Code of the laboratory service
Binding: ActionCode (example): Provides examples of actions to be performed.


ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Code for the laboratory service
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
...... coding:orderCodeLOINC SΣ 0..1 Coding LOINC code for the laboratory service
ele-1: All FHIR elements must have a @value or children
....... system SΣ 0..1 uri LOINC code system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://loinc.org
.... Slices for trigger S 0..* TriggerDefinition When the action should be triggered
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
..... trigger:Reflex 0..* TriggerDefinition Reflex laboratory procedure
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: named-event
...... name ΣC 1..1 string Name or URI that identifies the event
ele-1: All FHIR elements must have a @value or children
...... timing[x] ΣC 0..1 Timing of the event
ele-1: All FHIR elements must have a @value or children
....... timingTiming Timing
....... timingReference Reference(Schedule)
....... timingDate date
....... timingDateTime dateTime
...... data ΣC 0..* DataRequirement Triggering data of the event (multiple = 'and')
ele-1: All FHIR elements must have a @value or children
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.


ele-1: All FHIR elements must have a @value or children
Fixed Value: logical-group
.... definition[x] S 0..1 canonical(Laboratory Procedure Definition) Description of the activity to be performed
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.useContext:Orderable.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:Orderable.value[x]examplePattern: LABOE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:PathologistInitiative.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:PathologistInitiative.value[x]examplePattern: LABRREV
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:OneGender.codeextensiblePattern: gender
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.useContext:StoreSpecimen.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:StoreSpecimen.value[x]examplePattern: STORE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:AgeRange.codeextensiblePattern: age
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:AgeRange.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.typerequiredFixed Value: successor
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.typerequiredFixed Value: composed-of
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
PlanDefinition.action.codeexampleActionCode
http://hl7.org/fhir/ValueSet/action-code
from the FHIR Standard
PlanDefinition.action.trigger:Reflex.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|5.0.0
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredFixed Value: logical-group
http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3: goalid should reference the id of a goal definition
pld-4: targetId should reference the id of an action
... 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 BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... 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 pattern:code, type:value, pattern: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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
....... display 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
.... useContext:PathologistInitiative Σ 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
....... display 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
.... useContext:OneGender Σ 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 Σ 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
....... display 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
.... useContext:AgeRange Σ 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 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.


Fixed Value: 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 BindingsPurpose
CommonLanguages Starter Set

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


Fixed Value: 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 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.


Fixed Value: 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 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
Fixed Value: 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 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.


Fixed Value: 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
pld-0: Input data elements must have a requirement or a relatedData, but not both
..... 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
pld-1: Output data element must have a requirement or a relatedData, but not both
..... 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.


Fixed Value: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.useContext:Orderable.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:Orderable.value[x]examplePattern: LABOE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:PathologistInitiative.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:PathologistInitiative.value[x]examplePattern: LABRREV
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:OneGender.codeextensiblePattern: gender
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.useContext:StoreSpecimen.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:StoreSpecimen.value[x]examplePattern: STORE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:AgeRange.codeextensiblePattern: age
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:AgeRange.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PlanDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.document.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.document.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.typerequiredFixed Value: successor
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.typerequiredFixed Value: composed-of
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG
PlanDefinition.relatedArtifact:Bibliography.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
PlanDefinition.goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
PlanDefinition.goal.startexampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
PlanDefinition.goal.addressesexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
PlanDefinition.goal.target.measureexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
PlanDefinition.actor.option.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.actor.option.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
PlanDefinition.action.codeexampleActionCode
http://hl7.org/fhir/ValueSet/action-code
from the FHIR Standard
PlanDefinition.action.reasonexampleActionReasonCode
http://hl7.org/fhir/ValueSet/action-reason-code
from the FHIR Standard
PlanDefinition.action.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.action.trigger:Reflex.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|5.0.0
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredActionConditionKind
http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.endRelationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.participant.functionexampleActionParticipantFunction
http://hl7.org/fhir/ValueSet/action-participant-function
from the FHIR Standard
PlanDefinition.action.typeextensibleActionType
http://hl7.org/fhir/ValueSet/action-type
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredFixed Value: logical-group
http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior
http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0
from the FHIR Standard
PlanDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard

This structure is derived from PlanDefinition

Differential View

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... 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 pattern:code, type:value, pattern: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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender 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 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange 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 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
Fixed Value: 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 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
Fixed Value: successor
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Includes 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
Fixed Value: composed-of
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Bibliography 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
Fixed Value: http://loinc.org
.... Slices for trigger S 0..* TriggerDefinition When the action should be triggered
Slice: Unordered, Open by value:type
..... trigger:Reflex 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
Fixed Value: named-event
...... name 1..1 string Name or URI that identifies the event
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Fixed Value: logical-group
.... definition[x] S 0..1 canonical(Laboratory Procedure Definition) Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3: goalid should reference the id of a goal definition
pld-4: targetId should reference the id of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:CatalogReference 0..* Reference(Catalog Header) Reference to a catalog exposing this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ServiceBillingCode 0..* CodeableConcept A billing code associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:BillingSummary 0..1 (Complex) Textual summary of billing applied to the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ScheduleSummary 0..1 string Textual summary of the schedule of the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:LimitationSummary 0..1 string Textual summary of limitations associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:RegulatorySummary 0..1 string Textual summary of regulations applicable to this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ResultInterpretationSummary 0..1 markdown markdown summary of result interpretation guidance for this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... type SΣ 0..1 CodeableConcept panel | test
Binding: Types of diagnostic services performed by a laboratory (extensible)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... description Σ 0..1 markdown Natural language description of the plan definition
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:OtherDescription 0..* (Complex) Translation in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for useContext SΣ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code, type:value, pattern:value
ele-1: All FHIR elements must have a @value or children
.... useContext:Orderable SΣ 0..1 UsageContext Service is orderable
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative Σ 0..1 UsageContext Service may be added by pathologist
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender Σ 0..1 UsageContext service restricted to one gender
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
.... useContext:StoreSpecimen Σ 0..1 UsageContext Specimens to be kept
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange Σ 0..* UsageContext A patient age range applicable for this service
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
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
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.


ele-1: All FHIR elements must have a @value or children
... usage S 0..1 markdown Describes the clinical usage of the laboratory diagnostic service
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept categorization of the laboratory service
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


ele-1: All FHIR elements must have a @value or children
... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:InputDocumentExpected 0..* RelatedArtifact Input document expected by the laboratory service
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: depends-on
..... label Σ 1..1 string Name of the kind of document expected
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Brief description of the related artifact
ele-1: All FHIR elements must have a @value or children
..... document Σ 0..1 Attachment Document model
ele-1: All FHIR elements must have a @value or children
...... url Σ 0..1 url url of the model of document expected
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Title of the kind or model of document
ele-1: All FHIR elements must have a @value or children
Example General: Official Corporate Logo
.... relatedArtifact:IsReplacedBy 0..* RelatedArtifact Reference to a service replacing the current non-usable one
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: successor
..... resource Σ 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:Includes 0..* RelatedArtifact Reference to a panel or test included by the current one
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: composed-of
..... resource Σ 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
ele-1: All FHIR elements must have a @value or children
.... relatedArtifact:Bibliography 0..* RelatedArtifact Additional documentation, citation or justification
ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 code documentation | justification | citation
Binding: Types of bibliographic artifacts (required)
ele-1: All FHIR elements must have a @value or children
... action C 1..1 BackboneElement Action defined by the plan
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:SpecimenRequested 0..* (Complex) Specimens required for this action
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... description 0..1 markdown Brief description of the laboratory service and its method
ele-1: All FHIR elements must have a @value or children
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.


ele-1: All FHIR elements must have a @value or children
.... code S 0..1 CodeableConcept Code of the laboratory service
Binding: ActionCode (example): Provides examples of actions to be performed.


ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Code for the laboratory service
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
...... coding:orderCodeLOINC SΣ 0..1 Coding LOINC code for the laboratory service
ele-1: All FHIR elements must have a @value or children
....... system SΣ 0..1 uri LOINC code system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://loinc.org
.... Slices for trigger S 0..* TriggerDefinition When the action should be triggered
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
..... trigger:Reflex 0..* TriggerDefinition Reflex laboratory procedure
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: named-event
...... name ΣC 1..1 string Name or URI that identifies the event
ele-1: All FHIR elements must have a @value or children
...... timing[x] ΣC 0..1 Timing of the event
ele-1: All FHIR elements must have a @value or children
....... timingTiming Timing
....... timingReference Reference(Schedule)
....... timingDate date
....... timingDateTime dateTime
...... data ΣC 0..* DataRequirement Triggering data of the event (multiple = 'and')
ele-1: All FHIR elements must have a @value or children
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.


ele-1: All FHIR elements must have a @value or children
Fixed Value: logical-group
.... definition[x] S 0..1 canonical(Laboratory Procedure Definition) Description of the activity to be performed
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.useContext:Orderable.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:Orderable.value[x]examplePattern: LABOE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:PathologistInitiative.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:PathologistInitiative.value[x]examplePattern: LABRREV
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:OneGender.codeextensiblePattern: gender
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.useContext:StoreSpecimen.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:StoreSpecimen.value[x]examplePattern: STORE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:AgeRange.codeextensiblePattern: age
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:AgeRange.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.typerequiredFixed Value: successor
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.typerequiredFixed Value: composed-of
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
PlanDefinition.action.codeexampleActionCode
http://hl7.org/fhir/ValueSet/action-code
from the FHIR Standard
PlanDefinition.action.trigger:Reflex.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|5.0.0
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredFixed Value: logical-group
http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3: goalid should reference the id of a goal definition
pld-4: targetId should reference the id of an action
... 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 BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... 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 pattern:code, type:value, pattern: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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
....... display 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
.... useContext:PathologistInitiative Σ 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
....... display 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
.... useContext:OneGender Σ 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 Σ 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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/v3-ActCode
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
....... display 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
.... useContext:AgeRange Σ 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 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.


Fixed Value: 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 BindingsPurpose
CommonLanguages Starter Set

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


Fixed Value: 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 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.


Fixed Value: 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 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
Fixed Value: 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 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.


Fixed Value: 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
pld-0: Input data elements must have a requirement or a relatedData, but not both
..... 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
pld-1: Output data element must have a requirement or a relatedData, but not both
..... 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.


Fixed Value: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.useContext:Orderable.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:Orderable.value[x]examplePattern: LABOE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:PathologistInitiative.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:PathologistInitiative.value[x]examplePattern: LABRREV
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:OneGender.codeextensiblePattern: gender
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.useContext:StoreSpecimen.codeextensiblePattern: task
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:StoreSpecimen.value[x]examplePattern: STORE
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.useContext:AgeRange.codeextensiblePattern: age
http://terminology.hl7.org/ValueSet/usage-context-type
PlanDefinition.useContext:AgeRange.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
PlanDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PlanDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.typerequiredFixed Value: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.document.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.document.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:InputDocumentExpected.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.typerequiredFixed Value: successor
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:IsReplacedBy.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.typerequiredFixed Value: composed-of
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:Includes.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG
PlanDefinition.relatedArtifact:Bibliography.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
PlanDefinition.goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
PlanDefinition.goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
PlanDefinition.goal.startexampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
PlanDefinition.goal.addressesexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
PlanDefinition.goal.target.measureexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
PlanDefinition.actor.option.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.actor.option.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
PlanDefinition.action.codeexampleActionCode
http://hl7.org/fhir/ValueSet/action-code
from the FHIR Standard
PlanDefinition.action.reasonexampleActionReasonCode
http://hl7.org/fhir/ValueSet/action-reason-code
from the FHIR Standard
PlanDefinition.action.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
PlanDefinition.action.trigger:Reflex.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|5.0.0
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredActionConditionKind
http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.relatedAction.endRelationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0
from the FHIR Standard
PlanDefinition.action.participant.roleexampleActionParticipantRole
http://terminology.hl7.org/ValueSet/action-participant-role
PlanDefinition.action.participant.functionexampleActionParticipantFunction
http://hl7.org/fhir/ValueSet/action-participant-function
from the FHIR Standard
PlanDefinition.action.typeextensibleActionType
http://hl7.org/fhir/ValueSet/action-type
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredFixed Value: logical-group
http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0
from the FHIR Standard
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior
http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0
from the FHIR Standard
PlanDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard

This structure is derived from PlanDefinition

 

Other representations of profile: CSV, Excel, Schematron