Order Catalog Implementation Guide
current - CI Build

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). 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

Defining URL:http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition
Version:current
Name:LabServiceDefinition
Title:Laboratory Service Definition
Status:Draft as of 2022-10-21 03:52:32+0000
Definition:

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.

Publisher:HL7 International - Orders and Observations Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition

Formal Views of Profile Content

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

This structure is derived from PlanDefinition

Summary

Mandatory: 1 element (5 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element PlanDefinition.useContext is sliced based on the values of pattern:code, type:value, pattern:value
  • The element PlanDefinition.relatedArtifact is sliced based on the value of value:type
  • The element PlanDefinition.action.code.coding is sliced based on the value of value:system
  • The element PlanDefinition.action.trigger is sliced based on the value of value:type

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*PlanDefinitionThe definition of a plan for a series of actions
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... CatalogReference 0..*Reference(Catalog Header)Reference to a catalog exposing this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
... ServiceBillingCode 0..*CodeableConceptA billing code associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
... ScheduleSummary 0..1stringTextual summary of the schedule of the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
... LimitationSummary 0..1stringTextual summary of limitations associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
... RegulatorySummary 0..1stringTextual summary of regulations applicable to this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
... ResultInterpretationSummary 0..1markdownmarkdown summary of result interpretation guidance for this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
... title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Synonym in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
... type S0..1CodeableConceptpanel | test
Binding: Types of diagnostic services performed by a laboratory (extensible)
... description 0..1markdownNatural language description of the plan definition
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherDescription 0..*(Complex)Translation in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
... Slices for useContext S0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code, type:value, pattern:value
.... useContext:Orderable S0..1UsageContextService is orderable
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1CodeableConceptValue that defines the context
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative 0..1UsageContextService may be added by pathologist
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1CodeableConceptValue that defines the context
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender 0..1UsageContextservice restricted to one gender
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: gender
..... value[x] 1..1CodeableConceptValue that defines the context
Binding: AdministrativeGender (required)
.... useContext:StoreSpecimen 0..1UsageContextSpecimens to be kept
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1CodeableConceptValue that defines the context
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange 0..*UsageContextA patient age range applicable for this service
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: age
..... value[x] 1..1Rangepatient age range applicable for this service
... usage S0..1stringDescribes the clinical usage of the laboratory diagnostic service
... topic S0..*CodeableConceptcategorization of the laboratory service
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations
Slice: Unordered, Open by value:type
.... relatedArtifact:InputDocumentExpected 0..*RelatedArtifactInput document expected by the laboratory service
..... type 1..1codedocumentation | 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..1stringName of the kind of document expected
..... display 1..1stringBrief description of the related artifact
..... document 0..1AttachmentDocument model
...... url 0..1urlurl of the model of document expected
...... title 0..1stringTitle of the kind or model of document
.... relatedArtifact:IsReplacedBy 0..*RelatedArtifactReference to a service replacing the current non-usable one
..... type 1..1codedocumentation | 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..1canonical(Laboratory Service Definition)What artifact is being referenced
.... relatedArtifact:Includes 0..*RelatedArtifactReference to a panel or test included by the current one
..... type 1..1codedocumentation | 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..1canonical(Laboratory Service Definition)What artifact is being referenced
.... relatedArtifact:Bibliography 0..*RelatedArtifactAdditional documentation, citation or justification
..... type 1..1codedocumentation | justification | citation
Binding: Types of bibliographic artifacts (required)
... action 1..1BackboneElementAction defined by the plan
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... SpecimenRequested 0..*(Complex)Specimens required for this action
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
.... description 0..1stringBrief description of the laboratory service and its method
.... priority 0..1coderoutine | urgent | asap | stat
.... code S0..1CodeableConceptCode of the laboratory service
..... Slices for coding 0..*CodingCode for the laboratory service
Slice: Unordered, Open by value:system
...... coding:orderCodeLOINC S0..1CodingLOINC code for the laboratory service
....... system S0..1uriLOINC code system
Fixed Value: http://loinc.org
.... Slices for trigger S0..*TriggerDefinitionWhen the action should be triggered
Slice: Unordered, Open by value:type
..... trigger:Reflex 0..*TriggerDefinitionReflex laboratory procedure
...... type 1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
...... name 1..1stringName or URI that identifies the event
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Fixed Value: logical-group
.... definition[x] S0..1canonical(Laboratory Procedure Definition)Description of the activity to be performed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*PlanDefinitionThe definition of a plan for a series of actions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... CatalogReference 0..*Reference(Catalog Header)Reference to a catalog exposing this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
... ServiceBillingCode 0..*CodeableConceptA billing code associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
... BillingSummary 0..1(Complex)Textual summary of billing applied to the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
... ScheduleSummary 0..1stringTextual summary of the schedule of the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
... LimitationSummary 0..1stringTextual summary of limitations associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
... RegulatorySummary 0..1stringTextual summary of regulations applicable to this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
... ResultInterpretationSummary 0..1markdownmarkdown summary of result interpretation guidance for this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name ΣC0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Synonym in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... subtitle 0..1stringSubordinate title of the plan definition
... type SΣ0..1CodeableConceptpanel | test
Binding: Types of diagnostic services performed by a laboratory (extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherDescription 0..*(Complex)Translation in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1markdownPrimitive value for markdown
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by pattern:code, type:value, pattern:value
.... useContext:Orderable SΣ0..1UsageContextService is orderable
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LABOE
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... useContext:PathologistInitiative Σ0..1UsageContextService may be added by pathologist
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LABRREV
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... useContext:OneGender Σ0..1UsageContextservice restricted to one gender
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: gender
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: AdministrativeGender (required)
.... useContext:StoreSpecimen Σ0..1UsageContextSpecimens to be kept
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: task
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: STORE
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... useContext:AgeRange Σ0..*UsageContextA patient age range applicable for this service
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
Required Pattern: At least the following
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: age
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1Rangepatient age range applicable for this service
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this plan definition is defined
... usage S0..1stringDescribes the clinical usage of the laboratory diagnostic service
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic S0..*CodeableConceptcategorization of the laboratory service
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact S0..*RelatedArtifactAdditional documentation, citations
Slice: Unordered, Open by value:type
.... relatedArtifact:InputDocumentExpected 0..*RelatedArtifactInput document expected by the laboratory service
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codedocumentation | 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)
Fixed Value: depends-on
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
..... label Σ1..1stringName of the kind of document expected
..... display Σ1..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentDocument model
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data 0..1base64BinaryData inline, base64ed
...... url Σ0..1urlurl of the model of document expected
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1integer64Number of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringTitle of the kind or model of document
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
...... height 0..1positiveIntHeight of the image in pixels (photo/video)
...... width 0..1positiveIntWidth of the image in pixels (photo/video)
...... frames 0..1positiveIntNumber of frames if > 1 (photo)
...... duration 0..1decimalLength in seconds (audio / video)
...... pages 0..1positiveIntNumber of printed pages
..... resource Σ0..1canonical(Resource)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
.... relatedArtifact:IsReplacedBy 0..*RelatedArtifactReference to a service replacing the current non-usable one
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codedocumentation | 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)
Fixed Value: successor
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentWhat document is being referenced
..... resource Σ1..1canonical(Laboratory Service Definition)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
.... relatedArtifact:Includes 0..*RelatedArtifactReference to a panel or test included by the current one
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codedocumentation | 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)
Fixed Value: composed-of
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentWhat document is being referenced
..... resource Σ1..1canonical(Laboratory Service Definition)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
.... relatedArtifact:Bibliography 0..*RelatedArtifactAdditional documentation, citation or justification
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codedocumentation | justification | citation
Binding: Types of bibliographic artifacts (required)
..... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... document Σ0..1AttachmentWhat document is being referenced
..... resource Σ0..1canonical(Resource)What artifact is being referenced
..... resourceReference Σ0..1Reference(Resource)What artifact, if not a conformance resource
..... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
..... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... library 0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
...... detailStringstring
...... detailBooleanboolean
...... detailIntegerinteger
...... detailRatioRatio
..... due 0..1DurationReach goal within
... actor 0..*BackboneElementActors within the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringUser-visible title
.... description 0..1markdownDescribes the actor
.... option 1..*BackboneElementWho or what can be this actor
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example)
... action 1..1BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... SpecimenRequested 0..*(Complex)Specimens required for this action
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 0..1stringUnique id for the action in the PlanDefinition
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the laboratory service and its method
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code S0..1CodeableConceptCode of the laboratory service
Binding: ActionCode (example): Provides examples of actions to be performed.

..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode for the laboratory service
Slice: Unordered, Open by value:system
...... coding:orderCodeLOINC SΣ0..1CodingLOINC code for the laboratory service
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ0..1uriLOINC code system
Fixed Value: http://loinc.org
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... reason 0..*CodeableConceptWhy the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.


.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type 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.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
..... subjectCanonicalcanonical(Any)
.... Slices for trigger S0..*TriggerDefinitionWhen the action should be triggered
Slice: Unordered, Open by value:type
..... trigger:Reflex 0..*TriggerDefinitionReflex laboratory procedure
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Binding: TriggerType (required)
Fixed Value: named-event
...... name Σ1..1stringName or URI that identifies the event
...... code Σ0..1CodeableConceptCoded definition of the event
...... subscriptionTopic Σ0..1canonical(SubscriptionTopic)What event
...... timing[x] Σ0..1Timing of the event
....... timingTimingTiming
....... timingReferenceReference(Schedule)
....... timingDatedate
....... timingDateTimedateTime
...... data Σ0..*DataRequirementTriggering data of the event (multiple = 'and')
...... condition Σ0..1ExpressionWhether the event triggers (boolean expression)
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input C0..*BackboneElementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1idWhat data is provided
.... output C0..*BackboneElementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... targetId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingAgeAge
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actorId 0..1stringWhat actor
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc.
Binding: ActionParticipantFunction (example)
.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.


Fixed Value: logical-group
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] S0..1canonical(Laboratory Procedure Definition)Description of the activity to be performed
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action
... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept

doco Documentation for this format