Order Catalog Implementation Guide
current - CI Build International flag

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 - Detailed Descriptions

Draft as of 2023-07-08

Definitions for the LabServiceDefinition resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. PlanDefinition
Comments

The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.

2. PlanDefinition.extension
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. PlanDefinition.extension:CatalogReference
SliceNameCatalogReference
Control0..?
TypeExtension(CatalogReference) (Extension Type: Reference(CatalogHeader))
4. PlanDefinition.extension:ServiceBillingCode
SliceNameServiceBillingCode
Control0..?
TypeExtension(ServiceBillingCode) (Extension Type: Choice of: CodeableConcept, Reference)
5. PlanDefinition.extension:BillingSummary
SliceNameBillingSummary
Control0..?
TypeExtension(BillingSummary) (Complex Extension)
6. PlanDefinition.extension:ScheduleSummary
SliceNameScheduleSummary
Control0..?
TypeExtension(ScheduleSummary) (Extension Type: string)
7. PlanDefinition.extension:LimitationSummary
SliceNameLimitationSummary
Control0..?
TypeExtension(LimitationSummary) (Extension Type: string)
8. PlanDefinition.extension:RegulatorySummary
SliceNameRegulatorySummary
Control0..?
TypeExtension(RegulatorySummary) (Extension Type: string)
9. PlanDefinition.extension:ResultInterpretationSummary
SliceNameResultInterpretationSummary
Control0..?
TypeExtension(ResultInterpretationSummary) (Extension Type: markdown)
10. PlanDefinition.title
Control0..?
11. PlanDefinition.title.extension
Control0..?
SlicingThis element introduces a set of slices on PlanDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. PlanDefinition.title.extension:OtherTitle
SliceNameOtherTitle
Definition

Expresses a synonym of the laboratory service in a specified language

Control0..?
TypeExtension(Translation) (Complex Extension)
13. PlanDefinition.type
BindingThe codes SHALL be taken from Types of diagnostic services performed by a laboratory; other codes may be used where these codes are not suitableThe codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable
Must Supporttrue
Comments

In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.

14. PlanDefinition.description
Comments

This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

15. PlanDefinition.description.extension
Control0..?
SlicingThis element introduces a set of slices on PlanDefinition.description.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. PlanDefinition.description.extension:OtherDescription
SliceNameOtherDescription
Definition

Translation of the description of the laboratory service in a specified language

Control0..?
TypeExtension(Translation) (Complex Extension)
17. PlanDefinition.useContext
Must Supporttrue
Comments

When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
  • pattern @ code,
  • pattern @ code,
18. PlanDefinition.useContext:Orderable
SliceNameOrderable
Definition

The presence of this slice indicates that the service is open to laboratory order entry

Control0..1
Must Supporttrue
19. PlanDefinition.useContext:Orderable.code
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
20. PlanDefinition.useContext:Orderable.value[x]
Control0..?
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABOE"/>
  </coding>
</valueCodeableConcept>
21. PlanDefinition.useContext:PathologistInitiative
SliceNamePathologistInitiative
Definition

The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order

Control0..1
22. PlanDefinition.useContext:PathologistInitiative.code
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
23. PlanDefinition.useContext:PathologistInitiative.value[x]
Control0..?
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABRREV"/>
  </coding>
</valueCodeableConcept>
24. PlanDefinition.useContext:OneGender
SliceNameOneGender
Definition

The presence of this slice indicates that the service is restricted to one gender of subject (female or male)

Control0..1
25. PlanDefinition.useContext:OneGender.code
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="gender"/>
</valueCoding>
26. PlanDefinition.useContext:OneGender.value[x]
Control0..?
BindingThe codes SHALL be taken from AdministrativeGender
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
27. PlanDefinition.useContext:StoreSpecimen
SliceNameStoreSpecimen
Definition

The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future

Control0..1
28. PlanDefinition.useContext:StoreSpecimen.code
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
29. PlanDefinition.useContext:StoreSpecimen.value[x]
Control0..?
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="STORE"/>
  </coding>
</valueCodeableConcept>
30. PlanDefinition.useContext:AgeRange
SliceNameAgeRange
Control0..?
31. PlanDefinition.useContext:AgeRange.code
Control0..?
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="age"/>
</valueCoding>
32. PlanDefinition.useContext:AgeRange.value[x]
Control0..?
TypeRange
[x] NoteSee Choice of Data Types for further information about how to use [x]
33. PlanDefinition.usage
Definition

A detailed description of how the laboratory diagnostic service is used from a clinical perspective.

A detailed description of how the plan definition is used from a clinical perspective.

Must Supporttrue
34. PlanDefinition.topic
Definition

Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ...

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

Must Supporttrue
Comments

Topics are usually chosen by the laboratory or the organization owning the catalog

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

35. PlanDefinition.relatedArtifact
Must Supporttrue
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
36. PlanDefinition.relatedArtifact:InputDocumentExpected
SliceNameInputDocumentExpected
Definition

Document that needs to be provided alongside the order for the laboratory service

Control0..?
Comments

Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...

37. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Control0..?
Fixed Valuedepends-on
38. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition

Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document.

Control1..?
Comments

Examples of kinds of documents expected include:

  • the paper lab order scanned
  • the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping)
  • the patient consent (e.g. for a genetic test)
  • the patient insurance affiliation scanned
39. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition

A brief description of the document that need to be provided alongside the order of this laboratory service

Control1..?
40. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition

provides in the attachment a model for the kind of document expected

Control0..?
Comments

The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.

41. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition

used if the model of document is accessible externally

Control0..?
42. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition

May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service.

Control0..?
43. PlanDefinition.relatedArtifact:IsReplacedBy
SliceNameIsReplacedBy
Definition

The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service

Control0..?
44. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition

The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance.

Control0..?
Fixed Valuesuccessor
45. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

Control1..?
Typecanonical(LabServiceDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. PlanDefinition.relatedArtifact:Includes
SliceNameIncludes
Definition

The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger.

Control0..?
47. PlanDefinition.relatedArtifact:Includes.type
Definition

The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one.

Control0..?
Fixed Valuecomposed-of
48. PlanDefinition.relatedArtifact:Includes.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

Control1..?
Typecanonical(LabServiceDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
49. PlanDefinition.relatedArtifact:Bibliography
SliceNameBibliography
Definition

Related bibliographic references such as documentation, justification, or citation.

Control0..?
50. PlanDefinition.relatedArtifact:Bibliography.type
Definition

kind of associated bibliographic artifact

Control0..?
BindingThe codes SHALL be taken from Types of bibliographic artifacts
51. PlanDefinition.action
Definition

The concrete action or group of actions conveyed by this laboratory diagnostic service

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

Control10..1*
Comments

The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

52. PlanDefinition.action.extension
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
53. PlanDefinition.action.extension:SpecimenRequested
SliceNameSpecimenRequested
Definition

A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.

Control0..?
TypeExtension(SpecimenRequested) (Complex Extension)
Comments

In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.

54. PlanDefinition.action.description
Definition

A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory

A brief description of the action used to provide a summary to display to the user.

55. PlanDefinition.action.priority
Definition

Indicates how quickly this diagnostic panel or test should be performed.

Indicates how quickly the action should be addressed with respect to other actions.

56. PlanDefinition.action.code
Definition

A code that provides meaning to the laboratory service

A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

Must Supporttrue
57. PlanDefinition.action.code.coding
Control0..?
SlicingThis element introduces a set of slices on PlanDefinition.action.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
58. PlanDefinition.action.code.coding:orderCodeLOINC
SliceNameorderCodeLOINC
Control0..1
Must Supporttrue
59. PlanDefinition.action.code.coding:orderCodeLOINC.system
Control0..?
Must Supporttrue
Fixed Valuehttp://loinc.org
60. PlanDefinition.action.trigger
Must Supporttrue
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
61. PlanDefinition.action.trigger:Reflex
SliceNameReflex
Definition

This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.

Control0..?
62. PlanDefinition.action.trigger:Reflex.type
Control0..?
Fixed Valuenamed-event
63. PlanDefinition.action.trigger:Reflex.name
Definition

The natural language expression of the trigger for the reflex laboratory procedure

Control1..?
64. PlanDefinition.action.groupingBehavior
Fixed Valuelogical-group
65. PlanDefinition.action.definition[x]
Definition

A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one.

A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

TypeChoice of: (LabProcedureDefinition|ActivityDefinition|MessageDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Comments

The definition is present only when there is no grouping of sub-actions

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.

Guidance on how to interpret the contents of this table can be found here.

1. PlanDefinition
Definition

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

Control0..*
Summaryfalse
Comments

The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.

InvariantsDefined on this element
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
pld-3: goalid should reference the id of a goal definition (: %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not())
pld-4: targetId should reference the id of an action (: %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not())
2. PlanDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. PlanDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Control0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

4. PlanDefinition.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
5. PlanDefinition.extension:CatalogReference
SliceNameCatalogReference
Definition

This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource

Control0..*
TypeExtension(CatalogReference) (Extension Type: Reference(CatalogHeader))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. PlanDefinition.extension:ServiceBillingCode
SliceNameServiceBillingCode
Definition

Optional Extension Element - found in all resources.

Control0..*
TypeExtension(ServiceBillingCode) (Extension Type: Choice of: CodeableConcept, Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. PlanDefinition.extension:BillingSummary
SliceNameBillingSummary
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..1*
TypeExtension(BillingSummary) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
8. PlanDefinition.extension:ScheduleSummary
SliceNameScheduleSummary
Definition

An Extension

Control0..1
TypeExtension(ScheduleSummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. PlanDefinition.extension:LimitationSummary
SliceNameLimitationSummary
Definition

An Extension

Control0..1
TypeExtension(LimitationSummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. PlanDefinition.extension:RegulatorySummary
SliceNameRegulatorySummary
Definition

An Extension

Control0..1
TypeExtension(RegulatorySummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. PlanDefinition.extension:ResultInterpretationSummary
SliceNameResultInterpretationSummary
Definition

An Extension

Control0..1
TypeExtension(ResultInterpretationSummary) (Extension Type: markdown)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. PlanDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. PlanDefinition.type
Definition

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

Control0..1
BindingThe codes SHALL be taken from Types of diagnostic services performed by a laboratory; other codes may be used where these codes are not suitableThe codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. PlanDefinition.status
Definition

The status of this plan definition. Enables tracking the life-cycle of the content.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus

The lifecycle status of an artifact.

Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. PlanDefinition.description
Definition

A free text natural language description of the plan definition from a consumer's perspective.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Comments

This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. PlanDefinition.description.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.description.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. PlanDefinition.description.extension:OtherDescription
SliceNameOtherDescription
Definition

Translation of the description of the laboratory service in a specified language

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TypeExtension(Translation) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
18. PlanDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
  • pattern @ code,
  • pattern @ code,
19. PlanDefinition.useContext:Orderable
SliceNameOrderable
Definition

The presence of this slice indicates that the service is open to laboratory order entry

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..1*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. PlanDefinition.useContext:Orderable.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. PlanDefinition.useContext:Orderable.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet

A code that defines the specific value for the context being specified.

TypeChoice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABOE"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. PlanDefinition.useContext:PathologistInitiative
SliceNamePathologistInitiative
Definition

The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..1*
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. PlanDefinition.useContext:PathologistInitiative.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. PlanDefinition.useContext:PathologistInitiative.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet

A code that defines the specific value for the context being specified.

TypeChoice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABRREV"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. PlanDefinition.useContext:OneGender
SliceNameOneGender
Definition

The presence of this slice indicates that the service is restricted to one gender of subject (female or male)

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..1*
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. PlanDefinition.useContext:OneGender.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="gender"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. PlanDefinition.useContext:OneGender.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingThe codes SHALL be taken from AdministrativeGenderFor example codes, see ContextOfUseValueSet
TypeChoice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. PlanDefinition.useContext:StoreSpecimen
SliceNameStoreSpecimen
Definition

The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..1*
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. PlanDefinition.useContext:StoreSpecimen.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. PlanDefinition.useContext:StoreSpecimen.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet

A code that defines the specific value for the context being specified.

TypeChoice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="STORE"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. PlanDefinition.useContext:AgeRange
SliceNameAgeRange
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..*
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. PlanDefinition.useContext:AgeRange.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="age"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. PlanDefinition.useContext:AgeRange.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
TypeChoice of: Range, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. PlanDefinition.usage
Definition

A detailed description of how the laboratory diagnostic service is used from a clinical perspective.

A detailed description of how the plan definition is used from a clinical perspective.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. PlanDefinition.topic
Definition

Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ...

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

Control0..*
BindingFor example codes, see DefinitionTopic

High-level categorization of the definition, used for searching, sorting, and filtering.

TypeCodeableConcept
Must Supporttrue
Summaryfalse
Requirements

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

Comments

Topics are usually chosen by the laboratory or the organization owning the catalog

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. PlanDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Must Supporttrue
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
37. PlanDefinition.relatedArtifact:InputDocumentExpected
SliceNameInputDocumentExpected
Definition

Document that needs to be provided alongside the order for the laboratory service

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Definition

The type of relationship to the related artifact.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType

The type of relationship to the related artifact.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuedepends-on
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition

Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document.

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Control10..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Examples of kinds of documents expected include:

  • the paper lab order scanned
  • the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping)
  • the patient consent (e.g. for a genetic test)
  • the patient insurance affiliation scanned
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition

A brief description of the document that need to be provided alongside the order of this laboratory service

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Control10..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition

provides in the attachment a model for the kind of document expected

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Control0..1
TypeAttachment
Summarytrue
Comments

The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition

used if the model of document is accessible externally

A location where the data can be accessed.

Control0..1
Typeurl
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Example
General:http://www.acme.com/logo-small.png
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition

May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service.

A label or set of text to display in place of the data.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Comments

May sometimes be derived from the source filename.

Example
General:Official Corporate Logo
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. PlanDefinition.relatedArtifact:IsReplacedBy
SliceNameIsReplacedBy
Definition

The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition

The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance.

The type of relationship to the related artifact.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType

The type of relationship to the related artifact.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuesuccessor
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

The related artifact, such as a library, value set, profile, or other knowledge resource.

Control10..1
Typecanonical(LabServiceDefinition|Resource)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. PlanDefinition.relatedArtifact:Includes
SliceNameIncludes
Definition

The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger.

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. PlanDefinition.relatedArtifact:Includes.type
Definition

The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one.

The type of relationship to the related artifact.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType

The type of relationship to the related artifact.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuecomposed-of
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. PlanDefinition.relatedArtifact:Includes.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

The related artifact, such as a library, value set, profile, or other knowledge resource.

Control10..1
Typecanonical(LabServiceDefinition|Resource)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. PlanDefinition.relatedArtifact:Bibliography
SliceNameBibliography
Definition

Related bibliographic references such as documentation, justification, or citation.

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. PlanDefinition.relatedArtifact:Bibliography.type
Definition

kind of associated bibliographic artifact

The type of relationship to the related artifact.

Control1..1
BindingThe codes SHALL be taken from Types of bibliographic artifactsThe codes SHALL be taken from RelatedArtifactType
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. PlanDefinition.action
Definition

The concrete action or group of actions conveyed by this laboratory diagnostic service

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

Control10..1* This element is affected by the following invariants: pld-3, pld-4
TypeBackboneElement
Summaryfalse
Comments

The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. PlanDefinition.action.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. PlanDefinition.action.extension:SpecimenRequested
SliceNameSpecimenRequested
Definition

A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TypeExtension(SpecimenRequested) (Complex Extension)
Comments

In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
55. PlanDefinition.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
56. PlanDefinition.action.description
Definition

A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory

A brief description of the action used to provide a summary to display to the user.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. PlanDefinition.action.priority
Definition

Indicates how quickly this diagnostic panel or test should be performed.

Indicates how quickly the action should be addressed with respect to other actions.

Control0..1
BindingThe codes SHALL be taken from RequestPriority

Identifies the level of importance to be assigned to actioning the request.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. PlanDefinition.action.code
Definition

A code that provides meaning to the laboratory service

A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

Control0..1
BindingFor example codes, see ActionCode

Provides examples of actions to be performed.

TypeCodeableConcept
Must Supporttrue
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. PlanDefinition.action.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
60. PlanDefinition.action.code.coding:orderCodeLOINC
SliceNameorderCodeLOINC
Definition

A reference to a code defined by a terminology system.

Control0..1*
TypeCoding
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. PlanDefinition.action.code.coding:orderCodeLOINC.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

Control0..*
TypeTriggerDefinition
Must Supporttrue
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
63. PlanDefinition.action.trigger:Reflex
SliceNameReflex
Definition

This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.

A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

Control0..*
TypeTriggerDefinition
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. PlanDefinition.action.trigger:Reflex.type
Definition

The type of triggering event.

Control1..1 This element is affected by the following invariants: trd-3
BindingThe codes SHALL be taken from TriggerType

The type of trigger.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuenamed-event
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. PlanDefinition.action.trigger:Reflex.name
Definition

The natural language expression of the trigger for the reflex laboratory procedure

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

Control10..1 This element is affected by the following invariants: trd-3
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. PlanDefinition.action.trigger:Reflex.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

Control0..1 This element is affected by the following invariants: trd-3, trd-1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. PlanDefinition.action.trigger:Reflex.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

Control0..* This element is affected by the following invariants: trd-3, trd-2, trd-1
TypeDataRequirement
Summarytrue
Comments

This element shall be present for any data type trigger.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior

Defines organization behavior of a group.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
Fixed Valuelogical-group
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. PlanDefinition.action.definition[x]
Definition

A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one.

A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

Control0..1
TypeChoice of: canonical(LabProcedureDefinition|ActivityDefinition|MessageDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition), uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Comments

The definition is present only when there is no grouping of sub-actions

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. PlanDefinition
Definition

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

Control0..*
Summaryfalse
Comments

The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.

2. PlanDefinition.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

3. PlanDefinition.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. PlanDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. PlanDefinition.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from AllLanguages IETF language tag for a human languag
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. PlanDefinition.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. PlanDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Control0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

8. PlanDefinition.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. PlanDefinition.extension:CatalogReference
SliceNameCatalogReference
Definition

This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource

Control0..*
TypeExtension(CatalogReference) (Extension Type: Reference(CatalogHeader))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. PlanDefinition.extension:ServiceBillingCode
SliceNameServiceBillingCode
Definition

Optional Extension Element - found in all resources.

Control0..*
TypeExtension(ServiceBillingCode) (Extension Type: Choice of: CodeableConcept, Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. PlanDefinition.extension:BillingSummary
SliceNameBillingSummary
Definition

An Extension

Control0..1
TypeExtension(BillingSummary) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. PlanDefinition.extension:ScheduleSummary
SliceNameScheduleSummary
Definition

An Extension

Control0..1
TypeExtension(ScheduleSummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. PlanDefinition.extension:LimitationSummary
SliceNameLimitationSummary
Definition

An Extension

Control0..1
TypeExtension(LimitationSummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. PlanDefinition.extension:RegulatorySummary
SliceNameRegulatorySummary
Definition

An Extension

Control0..1
TypeExtension(RegulatorySummary) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. PlanDefinition.extension:ResultInterpretationSummary
SliceNameResultInterpretationSummary
Definition

An Extension

Control0..1
TypeExtension(ResultInterpretationSummary) (Extension Type: markdown)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. PlanDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. PlanDefinition.url
Definition

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the plan definition to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

InvariantsDefined on this element
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (: exists() implies matches('^[^|# ]+$'))
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. PlanDefinition.identifier
Definition

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. PlanDefinition.version
Definition

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. PlanDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Control0..1
BindingThe codes SHALL be taken from VersionAlgorithm; other codes may be used where these codes are not suitable
TypeChoice of: string, Coding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. PlanDefinition.name
Definition

A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1 This element is affected by the following invariants: cnl-0
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. PlanDefinition.title
Definition

A short, descriptive, user-friendly title for the plan definition.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. PlanDefinition.title.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
24. PlanDefinition.title.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
25. PlanDefinition.title.extension:OtherTitle
SliceNameOtherTitle
Definition

Expresses a synonym of the laboratory service in a specified language

Control0..*
TypeExtension(Translation) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. PlanDefinition.title.value
Definition

The actual value

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Max Length1048576
27. PlanDefinition.subtitle
Definition

An explanatory or alternate title for the plan definition giving additional information about its content.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. PlanDefinition.type
Definition

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

Control0..1
BindingThe codes SHALL be taken from Types of diagnostic services performed by a laboratory; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. PlanDefinition.status
Definition

The status of this plan definition. Enables tracking the life-cycle of the content.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus The lifecycle status of an artifact
Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. PlanDefinition.experimental
Definition

A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

Comments

Allows filtering of plan definitions that are appropriate for use versus not.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. PlanDefinition.subject[x]
Definition

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

Control0..1
BindingThe codes SHALL be taken from ParticipantResourceTypes; other codes may be used where these codes are not suitable The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)
TypeChoice of: CodeableConcept, Reference(Group|MedicinalProductDefinition|SubstanceDefinition|AdministrableProductDefinition|ManufacturedItemDefinition|PackagedProductDefinition), canonical(EvidenceVariable)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

Meaning if MissingPatient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. PlanDefinition.date
Definition

The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesRevision Date
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. PlanDefinition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summarytrue
Requirements

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. PlanDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. PlanDefinition.description
Definition

A free text natural language description of the plan definition from a consumer's perspective.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Comments

This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. PlanDefinition.description.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
37. PlanDefinition.description.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.description.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. PlanDefinition.description.extension:OtherDescription
SliceNameOtherDescription
Definition

Translation of the description of the laboratory service in a specified language

Control0..*
TypeExtension(Translation) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. PlanDefinition.description.value
Definition

Primitive value for markdown

Control0..1
Typemarkdown
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
40. PlanDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
  • pattern @ code,
  • pattern @ code,
41. PlanDefinition.useContext:Orderable
SliceNameOrderable
Definition

The presence of this slice indicates that the service is open to laboratory order entry

Control0..1
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. PlanDefinition.useContext:Orderable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
43. PlanDefinition.useContext:Orderable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. PlanDefinition.useContext:Orderable.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. PlanDefinition.useContext:Orderable.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet A code that defines the specific value for the context being specified
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABOE"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. PlanDefinition.useContext:PathologistInitiative
SliceNamePathologistInitiative
Definition

The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order

Control0..1
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. PlanDefinition.useContext:PathologistInitiative.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
48. PlanDefinition.useContext:PathologistInitiative.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. PlanDefinition.useContext:PathologistInitiative.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. PlanDefinition.useContext:PathologistInitiative.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet A code that defines the specific value for the context being specified
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="LABRREV"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. PlanDefinition.useContext:OneGender
SliceNameOneGender
Definition

The presence of this slice indicates that the service is restricted to one gender of subject (female or male)

Control0..1
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. PlanDefinition.useContext:OneGender.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
53. PlanDefinition.useContext:OneGender.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. PlanDefinition.useContext:OneGender.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="gender"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. PlanDefinition.useContext:OneGender.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingThe codes SHALL be taken from AdministrativeGender
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. PlanDefinition.useContext:StoreSpecimen
SliceNameStoreSpecimen
Definition

The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future

Control0..1
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. PlanDefinition.useContext:StoreSpecimen.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
58. PlanDefinition.useContext:StoreSpecimen.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
59. PlanDefinition.useContext:StoreSpecimen.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="task"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. PlanDefinition.useContext:StoreSpecimen.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet A code that defines the specific value for the context being specified
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="STORE"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. PlanDefinition.useContext:AgeRange
SliceNameAgeRange
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

Control0..*
TypeUsageContext
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. PlanDefinition.useContext:AgeRange.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
63. PlanDefinition.useContext:AgeRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. PlanDefinition.useContext:AgeRange.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
Pattern Value<valueCoding xmlns="http://hl7.org/fhir">
  <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
  <code value="age"/>
</valueCoding>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. PlanDefinition.useContext:AgeRange.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
TypeRange
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. PlanDefinition.jurisdiction
Definition

A legal or geographic region in which the plan definition is intended to be used.

Control0..*
BindingThe codes SHALL be taken from JurisdictionValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use
TypeCodeableConcept
Obligations
Obligations
??
Standards StatusDeprecated (from Trial Use)
Summarytrue
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. PlanDefinition.purpose
Definition

Explanation of why this plan definition is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
Comments

This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. PlanDefinition.usage
Definition

A detailed description of how the laboratory diagnostic service is used from a clinical perspective.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
Obligations
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. PlanDefinition.copyright
Definition

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.

Alternate NamesLicense, Restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. PlanDefinition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. PlanDefinition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. PlanDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. PlanDefinition.effectivePeriod
Definition

The period during which the plan definition content was or is planned to be in active use.

Control0..1
TypePeriod
Summarytrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.

Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. PlanDefinition.topic
Definition

Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ...

Control0..*
BindingFor example codes, see DefinitionTopic High-level categorization of the definition, used for searching, sorting, and filtering
TypeCodeableConcept
Must Supporttrue
Summaryfalse
Requirements

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

Comments

Topics are usually chosen by the laboratory or the organization owning the catalog

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. PlanDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Control0..*
TypeContactDetail
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. PlanDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Control0..*
TypeContactDetail
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. PlanDefinition.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

Control0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. PlanDefinition.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

Control0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. PlanDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Must Supporttrue
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
80. PlanDefinition.relatedArtifact:InputDocumentExpected
SliceNameInputDocumentExpected
Definition

Document that needs to be provided alongside the order for the laboratory service

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. PlanDefinition.relatedArtifact:InputDocumentExpected.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
82. PlanDefinition.relatedArtifact:InputDocumentExpected.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
83. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Definition

The type of relationship to the related artifact.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType The type of relationship to the related artifact
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuedepends-on
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. PlanDefinition.relatedArtifact:InputDocumentExpected.classifier
Definition

Provides additional classifiers of the related artifact.

Control0..*
BindingFor example codes, see CitationArtifactClassifier Additional classifiers for the related artifact
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition

Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Examples of kinds of documents expected include:

  • the paper lab order scanned
  • the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping)
  • the patient consent (e.g. for a genetic test)
  • the patient insurance affiliation scanned
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition

A brief description of the document that need to be provided alongside the order of this laboratory service

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. PlanDefinition.relatedArtifact:InputDocumentExpected.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition

provides in the attachment a model for the kind of document expected

Control0..1
TypeAttachment
Summarytrue
Comments

The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. PlanDefinition.relatedArtifact:InputDocumentExpected.document.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
90. PlanDefinition.relatedArtifact:InputDocumentExpected.document.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.document.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
91. PlanDefinition.relatedArtifact:InputDocumentExpected.document.contentType
Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Control0..1 This element is affected by the following invariants: att-1
BindingThe codes SHALL be taken from MimeTypes BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Example
General:text/plain; charset=UTF-8, image/png
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. PlanDefinition.relatedArtifact:InputDocumentExpected.document.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

Control0..1
BindingThe codes SHALL be taken from AllLanguages IETF language tag for a human language
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Users need to be able to choose between the languages in a set of attachments.

Example
General:en-AU
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. PlanDefinition.relatedArtifact:InputDocumentExpected.document.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Control0..1 This element is affected by the following invariants: att-1
Typebase64Binary
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition

used if the model of document is accessible externally

Control0..1
Typeurl
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Example
General:http://www.acme.com/logo-small.png
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. PlanDefinition.relatedArtifact:InputDocumentExpected.document.size
Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Control0..1
Typeinteger64
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. PlanDefinition.relatedArtifact:InputDocumentExpected.document.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Control0..1
Typebase64Binary
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
97. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition

May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Comments

May sometimes be derived from the source filename.

Example
General:Official Corporate Logo
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. PlanDefinition.relatedArtifact:InputDocumentExpected.document.creation
Definition

The date that the attachment was first created.

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This is often tracked as an integrity issue for use of the attachment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. PlanDefinition.relatedArtifact:InputDocumentExpected.document.height
Definition

Height of the image in pixels (photo/video).

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Standards StatusTrial Use (from Trial Use)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. PlanDefinition.relatedArtifact:InputDocumentExpected.document.width
Definition

Width of the image in pixels (photo/video).

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Standards StatusTrial Use (from Trial Use)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
101. PlanDefinition.relatedArtifact:InputDocumentExpected.document.frames
Definition

The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Standards StatusTrial Use (from Trial Use)
Summaryfalse
Comments

if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
102. PlanDefinition.relatedArtifact:InputDocumentExpected.document.duration
Definition

The duration of the recording in seconds - for audio and video.

Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Standards StatusTrial Use (from Trial Use)
Summaryfalse
Comments

The duration might differ from occurrencePeriod if recording was paused.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. PlanDefinition.relatedArtifact:InputDocumentExpected.document.pages
Definition

The number of pages when printed.

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Standards StatusTrial Use (from Trial Use)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. PlanDefinition.relatedArtifact:InputDocumentExpected.resource
Definition

The related artifact, such as a library, value set, profile, or other knowledge resource.

Control0..1
Typecanonical(Resource)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. PlanDefinition.relatedArtifact:InputDocumentExpected.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Control0..1
TypeReference(Resource)
Summarytrue
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. PlanDefinition.relatedArtifact:InputDocumentExpected.publicationStatus
Definition

The publication status of the artifact being referred to.

Control0..1
BindingThe codes SHALL be taken from PublicationStatus Publication status of an artifact being referred to
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. PlanDefinition.relatedArtifact:InputDocumentExpected.publicationDate
Definition

The date of publication of the artifact being referred to.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. PlanDefinition.relatedArtifact:IsReplacedBy
SliceNameIsReplacedBy
Definition

The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
109. PlanDefinition.relatedArtifact:IsReplacedBy.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
110. PlanDefinition.relatedArtifact:IsReplacedBy.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
111. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition

The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType The type of relationship to the related artifact
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuesuccessor
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
112. PlanDefinition.relatedArtifact:IsReplacedBy.classifier
Definition

Provides additional classifiers of the related artifact.

Control0..*
BindingFor example codes, see CitationArtifactClassifier Additional classifiers for the related artifact
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. PlanDefinition.relatedArtifact:IsReplacedBy.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
114. PlanDefinition.relatedArtifact:IsReplacedBy.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
115. PlanDefinition.relatedArtifact:IsReplacedBy.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
116. PlanDefinition.relatedArtifact:IsReplacedBy.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Control0..1
TypeAttachment
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
117. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

Control1..1
Typecanonical(LabServiceDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. PlanDefinition.relatedArtifact:IsReplacedBy.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Control0..1
TypeReference(Resource)
Summarytrue
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
119. PlanDefinition.relatedArtifact:IsReplacedBy.publicationStatus
Definition

The publication status of the artifact being referred to.

Control0..1
BindingThe codes SHALL be taken from PublicationStatus Publication status of an artifact being referred to
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
120. PlanDefinition.relatedArtifact:IsReplacedBy.publicationDate
Definition

The date of publication of the artifact being referred to.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
121. PlanDefinition.relatedArtifact:Includes
SliceNameIncludes
Definition

The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
122. PlanDefinition.relatedArtifact:Includes.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
123. PlanDefinition.relatedArtifact:Includes.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
124. PlanDefinition.relatedArtifact:Includes.type
Definition

The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one.

Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType The type of relationship to the related artifact
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuecomposed-of
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. PlanDefinition.relatedArtifact:Includes.classifier
Definition

Provides additional classifiers of the related artifact.

Control0..*
BindingFor example codes, see CitationArtifactClassifier Additional classifiers for the related artifact
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
126. PlanDefinition.relatedArtifact:Includes.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
127. PlanDefinition.relatedArtifact:Includes.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
128. PlanDefinition.relatedArtifact:Includes.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. PlanDefinition.relatedArtifact:Includes.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Control0..1
TypeAttachment
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
130. PlanDefinition.relatedArtifact:Includes.resource
Definition

The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile

Control1..1
Typecanonical(LabServiceDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
131. PlanDefinition.relatedArtifact:Includes.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Control0..1
TypeReference(Resource)
Summarytrue
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
132. PlanDefinition.relatedArtifact:Includes.publicationStatus
Definition

The publication status of the artifact being referred to.

Control0..1
BindingThe codes SHALL be taken from PublicationStatus Publication status of an artifact being referred to
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
133. PlanDefinition.relatedArtifact:Includes.publicationDate
Definition

The date of publication of the artifact being referred to.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
134. PlanDefinition.relatedArtifact:Bibliography
SliceNameBibliography
Definition

Related bibliographic references such as documentation, justification, or citation.

Control0..*
TypeRelatedArtifact
Summaryfalse
Requirements

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
135. PlanDefinition.relatedArtifact:Bibliography.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
136. PlanDefinition.relatedArtifact:Bibliography.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
137. PlanDefinition.relatedArtifact:Bibliography.type
Definition

kind of associated bibliographic artifact

Control1..1
BindingThe codes SHALL be taken from Types of bibliographic artifacts
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
138. PlanDefinition.relatedArtifact:Bibliography.classifier
Definition

Provides additional classifiers of the related artifact.

Control0..*
BindingFor example codes, see CitationArtifactClassifier Additional classifiers for the related artifact
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
139. PlanDefinition.relatedArtifact:Bibliography.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
140. PlanDefinition.relatedArtifact:Bibliography.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
141. PlanDefinition.relatedArtifact:Bibliography.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
142. PlanDefinition.relatedArtifact:Bibliography.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Control0..1
TypeAttachment
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
143. PlanDefinition.relatedArtifact:Bibliography.resource
Definition

The related artifact, such as a library, value set, profile, or other knowledge resource.

Control0..1
Typecanonical(Resource)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. PlanDefinition.relatedArtifact:Bibliography.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Control0..1
TypeReference(Resource)
Summarytrue
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. PlanDefinition.relatedArtifact:Bibliography.publicationStatus
Definition

The publication status of the artifact being referred to.

Control0..1
BindingThe codes SHALL be taken from PublicationStatus Publication status of an artifact being referred to
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. PlanDefinition.relatedArtifact:Bibliography.publicationDate
Definition

The date of publication of the artifact being referred to.

Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
147. PlanDefinition.library
Definition

A reference to a Library resource containing any formal logic used by the plan definition.

Control0..*
Typecanonical(Library)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
148. PlanDefinition.goal
Definition

A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

Control0..* This element is affected by the following invariants: pld-3
TypeBackboneElement
Summaryfalse
Requirements

Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
149. PlanDefinition.goal.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
150. PlanDefinition.goal.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
151. PlanDefinition.goal.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
152. PlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

Control0..1
BindingFor example codes, see GoalCategory Example codes for grouping goals for filtering or presentation
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
153. PlanDefinition.goal.description
Definition

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

Control1..1
BindingFor example codes, see SNOMEDCTClinicalFindings Describes goals that can be achieved
TypeCodeableConcept
Summaryfalse
Comments

If no code is available, use CodeableConcept.text.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
154. PlanDefinition.goal.priority
Definition

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

Control0..1
BindingThe codes SHOULD be taken from GoalPriority Indicates the level of importance associated with reaching or sustaining a goal
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
155. PlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

Control0..1
BindingFor example codes, see GoalStartEvent Identifies the types of events that might trigger the start of a goal
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
156. PlanDefinition.goal.addresses
Definition

Identifies problems, conditions, issues, or concerns the goal is intended to address.

Control0..*
BindingFor example codes, see ConditionProblemDiagnosisCodes Identifies problems, conditions, issues, or concerns that goals may address
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
157. PlanDefinition.goal.documentation
Definition

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

Control0..*
TypeRelatedArtifact
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. PlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
159. PlanDefinition.goal.target.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
160. PlanDefinition.goal.target.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
161. PlanDefinition.goal.target.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
162. PlanDefinition.goal.target.measure
Definition

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Control0..1
BindingFor example codes, see LOINCCodes Identifies types of parameters that can be tracked to determine goal achievement
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
163. PlanDefinition.goal.target.detail[x]
Definition

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

Control0..1
TypeChoice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
164. PlanDefinition.goal.target.due
Definition

Indicates the timeframe after the start of the goal in which the goal should be met.

Control0..1
TypeDuration
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
165. PlanDefinition.actor
Definition

Actors represent the individuals or groups involved in the execution of the defined set of activities.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
166. PlanDefinition.actor.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
167. PlanDefinition.actor.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
168. PlanDefinition.actor.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
169. PlanDefinition.actor.title
Definition

A descriptive label for the actor.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
170. PlanDefinition.actor.description
Definition

A description of how the actor fits into the overall actions of the plan definition.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
171. PlanDefinition.actor.option
Definition

The characteristics of the candidates that could serve as the actor.

Control1..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
172. PlanDefinition.actor.option.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
173. PlanDefinition.actor.option.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
174. PlanDefinition.actor.option.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
175. PlanDefinition.actor.option.type
Definition

The type of participant in the action.

Control0..1
BindingThe codes SHALL be taken from ActionParticipantType The type of participant in the activity
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
176. PlanDefinition.actor.option.typeCanonical
Definition

The type of participant in the action.

Control0..1
Typecanonical(CapabilityStatement)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
177. PlanDefinition.actor.option.typeReference
Definition

The type of participant in the action.

Control0..1
TypeReference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson)
Summaryfalse
Comments

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
178. PlanDefinition.actor.option.role
Definition

The role the participant should play in performing the described action.

Control0..1
BindingFor example codes, see Action Participant Role
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
179. PlanDefinition.action
Definition

The concrete action or group of actions conveyed by this laboratory diagnostic service

Control1..1 This element is affected by the following invariants: pld-3, pld-4
TypeBackboneElement
Summaryfalse
Comments

The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.

180. PlanDefinition.action.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
181. PlanDefinition.action.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
182. PlanDefinition.action.extension:SpecimenRequested
SliceNameSpecimenRequested
Definition

A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.

Control0..*
TypeExtension(SpecimenRequested) (Complex Extension)
Comments

In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
183. PlanDefinition.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
184. PlanDefinition.action.linkId
Definition

An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
185. PlanDefinition.action.prefix
Definition

A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
186. PlanDefinition.action.title
Definition

The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
187. PlanDefinition.action.description
Definition

A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
188. PlanDefinition.action.textEquivalent
Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
189. PlanDefinition.action.priority
Definition

Indicates how quickly this diagnostic panel or test should be performed.

Control0..1
BindingThe codes SHALL be taken from RequestPriority Identifies the level of importance to be assigned to actioning the request
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
190. PlanDefinition.action.code
Definition

A code that provides meaning to the laboratory service

Control0..1
BindingFor example codes, see ActionCode Provides examples of actions to be performed
TypeCodeableConcept
Must Supporttrue
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
191. PlanDefinition.action.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
192. PlanDefinition.action.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
193. PlanDefinition.action.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
194. PlanDefinition.action.code.coding:orderCodeLOINC
SliceNameorderCodeLOINC
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
195. PlanDefinition.action.code.coding:orderCodeLOINC.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
196. PlanDefinition.action.code.coding:orderCodeLOINC.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
197. PlanDefinition.action.code.coding:orderCodeLOINC.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://loinc.org
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
198. PlanDefinition.action.code.coding:orderCodeLOINC.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
199. PlanDefinition.action.code.coding:orderCodeLOINC.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1 This element is affected by the following invariants: cod-1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
200. PlanDefinition.action.code.coding:orderCodeLOINC.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1 This element is affected by the following invariants: cod-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
201. PlanDefinition.action.code.coding:orderCodeLOINC.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
202. PlanDefinition.action.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
203. PlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

Control0..*
BindingFor example codes, see ActionReasonCode Provides examples of reasons for actions to be performed
TypeCodeableConcept
Summaryfalse
Comments

This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
204. PlanDefinition.action.documentation
Definition

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Control0..*
TypeRelatedArtifact
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
205. PlanDefinition.action.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

Control0..* This element is affected by the following invariants: pld-3
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
206. PlanDefinition.action.subject[x]
Definition

A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

Control0..1
BindingThe codes SHALL be taken from ParticipantResourceTypes; other codes may be used where these codes are not suitable The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)
TypeChoice of: CodeableConcept, Reference(Group), canonical
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Meaning if MissingPatient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
207. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.

Control0..*
TypeTriggerDefinition
Must Supporttrue
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type
208. PlanDefinition.action.trigger:Reflex
SliceNameReflex
Definition

This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.

Control0..*
TypeTriggerDefinition
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
209. PlanDefinition.action.trigger:Reflex.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
210. PlanDefinition.action.trigger:Reflex.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
211. PlanDefinition.action.trigger:Reflex.type
Definition

The type of triggering event.

Control1..1 This element is affected by the following invariants: trd-3
BindingThe codes SHALL be taken from TriggerType The type of trigger
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuenamed-event
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
212. PlanDefinition.action.trigger:Reflex.name
Definition

The natural language expression of the trigger for the reflex laboratory procedure

Control1..1 This element is affected by the following invariants: trd-3
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
213. PlanDefinition.action.trigger:Reflex.code
Definition

A code that identifies the event.

Control0..1
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
214. PlanDefinition.action.trigger:Reflex.subscriptionTopic
Definition

A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.

Control0..1
Typecanonical(SubscriptionTopic)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
215. PlanDefinition.action.trigger:Reflex.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

Control0..1 This element is affected by the following invariants: trd-3, trd-1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
216. PlanDefinition.action.trigger:Reflex.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

Control0..* This element is affected by the following invariants: trd-3, trd-2, trd-1
TypeDataRequirement
Summarytrue
Comments

This element shall be present for any data type trigger.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
217. PlanDefinition.action.trigger:Reflex.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

Control0..1 This element is affected by the following invariants: trd-2
TypeExpression
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
218. PlanDefinition.action.condition
Definition

An expression that describes applicability criteria or start/stop conditions for the action.

Control0..*
TypeBackboneElement
Summaryfalse
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
219. PlanDefinition.action.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
220. PlanDefinition.action.condition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
221. PlanDefinition.action.condition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
222. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind Defines the kinds of conditions that can appear on actions
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
223. PlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

Control0..1
TypeExpression
Summaryfalse
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
224. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
pld-0: Input data elements must have a requirement or a relatedData, but not both (: requirement.exists() xor relatedData.exists())
225. PlanDefinition.action.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
226. PlanDefinition.action.input.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
227. PlanDefinition.action.input.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
228. PlanDefinition.action.input.title
Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
229. PlanDefinition.action.input.requirement
Definition

Defines the data that is to be provided as input to the action.

Control0..1 This element is affected by the following invariants: pld-0
TypeDataRequirement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
230. PlanDefinition.action.input.relatedData
Definition

Points to an existing input or output element that provides data to this input.

Control0..1 This element is affected by the following invariants: pld-0
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
231. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
pld-1: Output data element must have a requirement or a relatedData, but not both (: requirement.exists() xor relatedData.exists())
232. PlanDefinition.action.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
233. PlanDefinition.action.output.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
234. PlanDefinition.action.output.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
235. PlanDefinition.action.output.title
Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
236. PlanDefinition.action.output.requirement
Definition

Defines the data that results as output from the action.

Control0..1 This element is affected by the following invariants: pld-1
TypeDataRequirement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
237. PlanDefinition.action.output.relatedData
Definition

Points to an existing input or output element that is results as output from the action.

Control0..1 This element is affected by the following invariants: pld-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
238. PlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Control0..* This element is affected by the following invariants: pld-4
TypeBackboneElement
Summaryfalse
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
239. PlanDefinition.action.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
240. PlanDefinition.action.relatedAction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
241. PlanDefinition.action.relatedAction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
242. PlanDefinition.action.relatedAction.targetId
Definition

The element id of the target related action.

Control1..1 This element is affected by the following invariants: pld-4
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
243. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of the start of this action to the related action.

Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType Defines the types of relationships between actions
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
244. PlanDefinition.action.relatedAction.endRelationship
Definition

The relationship of the end of this action to the related action.

Control0..1
BindingThe codes SHALL be taken from ActionRelationshipType Defines the types of relationships between actions
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
245. PlanDefinition.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Control0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
246. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

Control0..1
TypeChoice of: Age, Duration, Range, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
Requirements

Allows prompting for activities and detection of missed planned activities.

Comments

The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
247. PlanDefinition.action.location
Definition

Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

Control0..1
TypeCodeableReference(Location)
Summaryfalse
Requirements

Helps in planning of activity.

Alternate Namesfacility
Comments

May reference a specific clinical location or may just identify a type of location.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
248. PlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
249. PlanDefinition.action.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
250. PlanDefinition.action.participant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
251. PlanDefinition.action.participant.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
252. PlanDefinition.action.participant.actorId
Definition

A reference to the id element of the actor who will participate in this action.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
253. PlanDefinition.action.participant.type
Definition

The type of participant in the action.

Control0..1
BindingThe codes SHALL be taken from ActionParticipantType The type of participant in the activity
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
254. PlanDefinition.action.participant.typeCanonical
Definition

The type of participant in the action.

Control0..1
Typecanonical(CapabilityStatement)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
255. PlanDefinition.action.participant.typeReference
Definition

The type of participant in the action.

Control0..1
TypeReference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson)
Summaryfalse
Comments

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
256. PlanDefinition.action.participant.role
Definition

The role the participant should play in performing the described action.

Control0..1
BindingFor example codes, see Action Participant Role Defines roles played by participants for the action
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
257. PlanDefinition.action.participant.function
Definition

Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

Control0..1
BindingFor example codes, see ActionParticipantFunction
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
258. PlanDefinition.action.type
Definition

The type of action to perform (create, update, remove).

Control0..1
BindingThe codes SHALL be taken from ActionType; other codes may be used where these codes are not suitable The type of action to be performed
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
259. PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior Defines organization behavior of a group
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
Fixed Valuelogical-group
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
260. PlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior Defines selection behavior of a group
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
261. PlanDefinition.action.requiredBehavior
Definition

Defines the required behavior for the action.

Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior Defines expectations around whether an action or action group is required
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
262. PlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior Defines selection frequency behavior for an action or group
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
263. PlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeated
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Meaning if MissingIf no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
264. PlanDefinition.action.definition[x]
Definition

A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one.

Control0..1
Typecanonical(LabProcedureDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Comments

The definition is present only when there is no grouping of sub-actions

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
265. PlanDefinition.action.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Control0..1
Typecanonical(StructureMap)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
266. PlanDefinition.action.dynamicValue
Definition

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

Control0..*
TypeBackboneElement
Summaryfalse
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
267. PlanDefinition.action.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
268. PlanDefinition.action.dynamicValue.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
269. PlanDefinition.action.dynamicValue.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
270. PlanDefinition.action.dynamicValue.path
Definition

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
271. PlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Control0..1
TypeExpression
Summaryfalse
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
272. PlanDefinition.action.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
273. PlanDefinition.asNeeded[x]
Definition

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

Control0..1
BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodes A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc
TypeChoice of: boolean, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))