Order Catalog Implementation Guide
1.0.0 - STU 1

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

## Resource Profile: LabProcedureDefinition - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the LabProcedureDefinition resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. ActivityDefinition
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
Short | The definition of a specific activity to be taken, independent of any particular patient or context
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | 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}$'))
2. ActivityDefinition.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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ActivityDefinition.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.
Short | Contained, inline 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.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. ActivityDefinition.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).
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
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 Names | extensions, user content
Invariants | 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())
8. ActivityDefinition.url
Definition | An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
Short | Canonical identifier for this activity definition, represented as a URI (globally unique)
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.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Allows the activity definition to be referenced by a single globally unique identifier.
Invariants | 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()))
10. ActivityDefinition.title
Definition | A short, descriptive, user-friendly title for the activity definition.
Short | Name for this activity definition (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ActivityDefinition.title.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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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())
Slicing | This element introduces a set of slices on `ActivityDefinition.title.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
14. ActivityDefinition.title.extension:OtherTitle
Slice Name | OtherTitle
Definition | Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended.
Short | Language Translation (Localization)
Control | 0..*
Type | Extension(Translation) (Complex Extension)
Is Modifier | false
Invariants | 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. ActivityDefinition.status
Definition | The status of this activity definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ActivityDefinition.date
Definition | The date (and optionally time) when the activity 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 activity definition changes.
Short | Date last changed
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 activity 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. 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 activity 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.
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ActivityDefinition.publisher
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.
Short | Name of the publisher/steward (organization or individual)
Comments | Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity 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 activity definition. This item SHOULD be populated unless the information is available from context.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ActivityDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ActivityDefinition.contact.telecom
Definition | The contact details for the individual (if a name was provided) or the organization.
Short | Contact details for individual or organization
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ActivityDefinition.description
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective. A free text natural language description of the activity definition from a consumer's perspective.
Short | Natural language description of the activity definition
Comments | 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 activity 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 activity definition is presumed to be the predominant language in the place the activity definition was created).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ActivityDefinition.effectivePeriod
Definition | The period during which the activity definition content was or is planned to be in active use.
Short | When the activity definition is expected to be used
Comments | The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ActivityDefinition.effectivePeriod.start
Definition | The start of the period. The boundary is inclusive.
Short | Starting time with inclusive boundary
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ActivityDefinition.effectivePeriod.end
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Short | End time with inclusive boundary, if not ongoing
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ActivityDefinition.topic
Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
Short | Categorization of the laboratory procedureE.g. Education, Treatment, Assessment, etc
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ... 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)
Control | 0..*
Binding | For example codes, see DefinitionTopic http://hl7.org/fhir/ValueSet/definition-topic|5.0.0 (example to `http://hl7.org/fhir/ValueSet/definition-topic|5.0.0` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ActivityDefinition.kind
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
Short | Kind of resource
Comments | The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.
Control | 10..1
Binding | The codes SHALL be taken from RequestResourceTypes http://hl7.org/fhir/ValueSet/request-resource-types|5.0.0 (required to `http://hl7.org/fhir/ValueSet/request-resource-types|5.0.0` ) The kind of activity the definition is describing.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Pattern Value | `ServiceRequest`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ActivityDefinition.code
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
Short | Detail type of activity
Comments | Tends to be less relevant for activities involving particular products.
Control | 0..1
Binding | For example codes, see ProcedureCodesSNOMEDCT http://hl7.org/fhir/ValueSet/procedure-code|5.0.0 (example to `http://hl7.org/fhir/ValueSet/procedure-code|5.0.0` ) Detailed type of the activity; e.g. CBC.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows matching performed to planned as well as validation against protocols.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ActivityDefinition.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code for the laboratory procedureCode defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `ActivityDefinition.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
42. ActivityDefinition.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Definition | A reference to a code defined by a terminology system.
Short | LOINC code for the laboratory procedureCode defined by a terminology system
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.
Control | 0..1*
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ActivityDefinition.code.coding:orderCodeLOINC.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | LOINC test code for this activityIdentity of the terminology system
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.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Label | LOINC
Pattern Value | `http://loinc.org`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ActivityDefinition.doNotPerform
Definition | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
Short | True if the activity should not be performed
Comments | This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.
Control | 0..01
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ActivityDefinition.location
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
Short | The physical sector of the laboratory performing the procedureWhere it should happen
Comments | May be tha laboratory as a whole or its work area facility or a sector of it May reference a specific clinical location or may just identify a type of location.
Control | 0..1
Type | CodeableReference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | Helps in planning of activity.
Alternate Names | facility
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ActivityDefinition.specimenRequirement
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed. Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
Short | What specimens are required to perform this laboratory procedureWhat specimens are required to perform this action
Control | 0..*
Type | canonical(Laboratory IVD Specimen Definition, SpecimenDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Needed to represent lab order definitions.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ActivityDefinition.observationRequirement
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area. Defines observation requirements for the action to be performed, such as body weight or surface area.
Short | What observations are required to perform this laboratory procedureWhat observations are required to perform this action
Control | 0..*
Type | canonical(Input Observation, ObservationDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Needed to represent observation definitions.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ActivityDefinition.observationResultRequirement
Definition | Defines the observations that are expected to be produced by the laboratory procedure. Defines the observations that are expected to be produced by the action.
Short | What observations are produced by this laboratory procedureWhat observations must be produced by this action
Control | 0..*
Type | canonical(Laboratory Observation Definition, ObservationDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | 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 foundhere

0. ActivityDefinition
2. ActivityDefinition.url
Control | 1..?
4. ActivityDefinition.title
Must Support | true
6. ActivityDefinition.title.extension
Slicing | This element introduces a set of slices on `ActivityDefinition.title.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
8. ActivityDefinition.title.extension:OtherTitle
Slice Name | OtherTitle
Type | Extension(Translation) (Complex Extension)
10. ActivityDefinition.date
Must Support | true
12. ActivityDefinition.publisher
Must Support | true
14. ActivityDefinition.contact
16. ActivityDefinition.contact.telecom
Must Support | true
18. ActivityDefinition.description
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective.
Must Support | true
20. ActivityDefinition.effectivePeriod
22. ActivityDefinition.effectivePeriod.start
Must Support | true
24. ActivityDefinition.effectivePeriod.end
Must Support | true
26. ActivityDefinition.topic
Short | Categorization of the laboratory procedure
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ...
Must Support | true
28. ActivityDefinition.kind
Control | 1..?
Pattern Value | `ServiceRequest`
30. ActivityDefinition.code
Must Support | true
32. ActivityDefinition.code.coding
Short | Code for the laboratory procedure
Slicing | This element introduces a set of slices on `ActivityDefinition.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
34. ActivityDefinition.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Short | LOINC code for the laboratory procedure
Control | 0..1
Must Support | true
36. ActivityDefinition.code.coding:orderCodeLOINC.system
Short | LOINC test code for this activity
Must Support | true
Label | LOINC
Pattern Value | `http://loinc.org`
38. ActivityDefinition.doNotPerform
Control | 0..0
40. ActivityDefinition.location
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed
Short | The physical sector of the laboratory performing the procedure
Comments | May be tha laboratory as a whole or its work area facility or a sector of it
42. ActivityDefinition.specimenRequirement
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed.
Short | What specimens are required to perform this laboratory procedure
Type | canonical(Laboratory IVD Specimen Definition)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
44. ActivityDefinition.observationRequirement
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.
Short | What observations are required to perform this laboratory procedure
Type | canonical(Input Observation)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
46. ActivityDefinition.observationResultRequirement
Definition | Defines the observations that are expected to be produced by the laboratory procedure.
Short | What observations are produced by this laboratory procedure
Type | canonical(Laboratory Observation Definition)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. ActivityDefinition
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
Short | The definition of a specific activity to be taken, independent of any particular patient or context
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | 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}$')`)
2. ActivityDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
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.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. ActivityDefinition.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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. ActivityDefinition.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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. ActivityDefinition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
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).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. ActivityDefinition.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.
Short | Text summary of the resource, for human interpretation
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.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. ActivityDefinition.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.
Short | Contained, inline 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.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. ActivityDefinition.extension
Definition | 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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. ActivityDefinition.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).
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
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 Names | extensions, user content
Invariants | 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()`)
18. ActivityDefinition.url
Definition | An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
Short | Canonical identifier for this activity definition, represented as a URI (globally unique)
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.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Allows the activity definition to be referenced by a single globally unique identifier.
Invariants | 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())`)
20. ActivityDefinition.identifier
Definition | A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the activity definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. ActivityDefinition.version
Definition | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.
Short | Business version of the activity definition
Comments | There may be different activity 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 activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. ActivityDefinition.versionAlgorithm[x]
Definition | Indicates the mechanism used to compare versions to determine which is more current.
Short | How to compare versions
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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to `http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0` )
Type | Choice of: string, Coding
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. ActivityDefinition.name
Definition | A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Short | Name for this activity definition (computer friendly)
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.
Control | 0..1 This element is affected by the following invariants: cnl-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Support human navigation and code generation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. ActivityDefinition.title
Definition | A short, descriptive, user-friendly title for the activity definition.
Short | Name for this activity definition (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. ActivityDefinition.title.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. ActivityDefinition.title.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ActivityDefinition.title.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. ActivityDefinition.title.extension:OtherTitle
Slice Name | OtherTitle
Definition | Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended.
Short | Language Translation (Localization)
Control | 0..*
Type | Extension(Translation) (Complex Extension)
Is Modifier | false
Invariants | 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()`)
36. ActivityDefinition.title.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
38. ActivityDefinition.subtitle
Definition | An explanatory or alternate title for the activity definition giving additional information about its content.
Short | Subordinate title of the activity definition
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. ActivityDefinition.status
Definition | The status of this activity definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. ActivityDefinition.experimental
Definition | A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Short | For testing purposes, not real usage
Comments | Allows filtering of activity definitions that are appropriate for use versus not.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.
Meaning if Missing | If absent, this resource is treated as though it is not experimental.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. ActivityDefinition.subject[x]
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. 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.
Short | Type of individual the activity definition is intended for
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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to `http://hl7.org/fhir/ValueSet/participant-resource-types|5.0.0` ) The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. ActivityDefinition.date
Definition | The date (and optionally time) when the activity 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 activity definition changes.
Short | Date last changed
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 activity 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.
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. ActivityDefinition.publisher
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.
Short | Name of the publisher/steward (organization or individual)
Comments | Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity 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 activity definition. This item SHOULD be populated unless the information is available from context.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. ActivityDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. ActivityDefinition.contact.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. ActivityDefinition.contact.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ActivityDefinition.contact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. ActivityDefinition.contact.name
Definition | The name of an individual to contact.
Short | Name of an individual to contact
Comments | If there is no named individual, the telecom information is for the organization as a whole.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. ActivityDefinition.contact.telecom
Definition | The contact details for the individual (if a name was provided) or the organization.
Short | Contact details for individual or organization
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. ActivityDefinition.description
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective.
Short | Natural language description of the activity definition
Comments | 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 activity 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 activity definition is presumed to be the predominant language in the place the activity definition was created).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. ActivityDefinition.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 activity definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | false
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. ActivityDefinition.jurisdiction
Definition | A legal or geographic region in which the activity definition is intended to be used.
Short | Intended jurisdiction for activity definition (if applicable)
Comments | It may be possible for the activity 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.)
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. ActivityDefinition.purpose
Definition | Explanation of why this activity definition is needed and why it has been designed as it has.
Short | Why this activity definition is defined
Comments | This element does not describe the usage of the activity 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 activity definition.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. ActivityDefinition.usage
Definition | A detailed description of how the activity definition is used from a clinical perspective.
Short | Describes the clinical usage of the activity definition
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. ActivityDefinition.copyright
Definition | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
Short | Use and/or publishing restrictions
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.
Alternate Names | License, Restrictions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. ActivityDefinition.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').
Short | Copyright holder and year(s)
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Defines the content expected to be rendered in all representations of the artifact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. ActivityDefinition.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.
Short | When the activity definition was approved by publisher
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.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. ActivityDefinition.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.
Short | When the activity definition was last reviewed by the publisher
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. ActivityDefinition.effectivePeriod
Definition | The period during which the activity definition content was or is planned to be in active use.
Short | When the activity definition is expected to be used
Comments | The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. ActivityDefinition.effectivePeriod.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
82. ActivityDefinition.effectivePeriod.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ActivityDefinition.effectivePeriod.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
84. ActivityDefinition.effectivePeriod.start
Definition | The start of the period. The boundary is inclusive.
Short | Starting time with inclusive boundary
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. ActivityDefinition.effectivePeriod.end
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Short | End time with inclusive boundary, if not ongoing
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. ActivityDefinition.topic
Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
Short | Categorization of the laboratory procedure
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ...
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic|5.0.0` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. ActivityDefinition.author
Definition | An individiual or organization primarily involved in the creation and maintenance of the content.
Short | Who authored the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. ActivityDefinition.editor
Definition | An individual or organization primarily responsible for internal coherence of the content.
Short | Who edited the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. ActivityDefinition.reviewer
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
Short | Who reviewed the content
Comments | See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. ActivityDefinition.endorser
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
Short | Who endorsed the content
Comments | See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. ActivityDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Additional documentation, citations, etc
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | false
Summary | false
Requirements | Activity 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. ActivityDefinition.library
Definition | A reference to a Library resource containing any formal logic used by the activity definition.
Short | Logic used by the activity definition
Control | 0..*
Type | canonical(Library)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. ActivityDefinition.kind
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
Short | Kind of resource
Comments | The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.
Control | 1..1
Binding | The codes SHALL be taken from RequestResourceTypes (required to `http://hl7.org/fhir/ValueSet/request-resource-types|5.0.0` ) The kind of activity the definition is describing.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Pattern Value | `ServiceRequest`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. ActivityDefinition.profile
Definition | A profile to which the target of the activity definition is expected to conform.
Short | What profile the resource needs to conform to
Control | 0..1
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. ActivityDefinition.code
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
Short | Detail type of activity
Comments | Tends to be less relevant for activities involving particular products.
Control | 0..1
Binding | For example codes, see ProcedureCodesSNOMEDCT (example to `http://hl7.org/fhir/ValueSet/procedure-code|5.0.0` ) Detailed type of the activity; e.g. CBC.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows matching performed to planned as well as validation against protocols.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. ActivityDefinition.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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
110. ActivityDefinition.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ActivityDefinition.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
112. ActivityDefinition.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code for the laboratory procedure
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `ActivityDefinition.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
114. ActivityDefinition.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Definition | A reference to a code defined by a terminology system.
Short | LOINC code for the laboratory procedure
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.
Control | 0..1
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. ActivityDefinition.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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
118. ActivityDefinition.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
Slicing | This element introduces a set of slices on `ActivityDefinition.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
120. ActivityDefinition.code.coding:orderCodeLOINC.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | LOINC test code for this activity
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.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Label | LOINC
Pattern Value | `http://loinc.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. ActivityDefinition.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.
Short | Version of the system - if relevant
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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. ActivityDefinition.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).
Short | Symbol in syntax defined by the system
Control | 0..1 This element is affected by the following invariants: cod-1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. ActivityDefinition.code.coding:orderCodeLOINC.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1 This element is affected by the following invariants: cod-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. ActivityDefinition.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).
Short | If this coding was chosen directly by the user
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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. ActivityDefinition.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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. ActivityDefinition.intent
Definition | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
Short | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Control | 0..1
Binding | The codes SHALL be taken from RequestIntent (required to `http://hl7.org/fhir/ValueSet/request-intent|5.0.0` ) Codes indicating the degree of authority/intentionality associated with a request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. ActivityDefinition.priority
Definition | Indicates how quickly the activity should be addressed with respect to other requests.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|5.0.0` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. ActivityDefinition.doNotPerform
Definition | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
Short | True if the activity should not be performed
Comments | This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.
Control | 0..0
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. ActivityDefinition.timing[x]
Definition | The timing or frequency upon which the described activity is to occur.
Short | When activity is to occur
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.
Control | 0..1
Type | Choice of: Timing, Age, Range, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | false
Summary | false
Requirements | Allows prompting for activities and detection of missed planned activities.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. ActivityDefinition.asNeeded[x]
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Short | Preconditions for service
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0` ) A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
Type | Choice of: boolean, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. ActivityDefinition.location
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed
Short | The physical sector of the laboratory performing the procedure
Comments | May be tha laboratory as a whole or its work area facility or a sector of it
Control | 0..1
Type | CodeableReference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | Helps in planning of activity.
Alternate Names | facility
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. ActivityDefinition.participant
Definition | Indicates who should participate in performing the action described.
Short | Who should participate in the action
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. ActivityDefinition.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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
148. ActivityDefinition.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
150. ActivityDefinition.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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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. ActivityDefinition.participant.type
Definition | The type of participant in the action.
Short | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Control | 0..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0` ) The type of participant in the activity.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. ActivityDefinition.participant.typeCanonical
Definition | The type of participant in the action.
Short | Who or what can participate
Control | 0..1
Type | canonical(CapabilityStatement)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. ActivityDefinition.participant.typeReference
Definition | The type of participant in the action.
Short | Who or what can participate
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).
Control | 0..1
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. ActivityDefinition.participant.role
Definition | The role the participant should play in performing the described action.
Short | E.g. Nurse, Surgeon, Parent, etc
Control | 0..1
Binding | For example codes, see Action Participant Role (example to `http://terminology.hl7.org/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. ActivityDefinition.participant.function
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc.
Short | E.g. Author, Reviewer, Witness, etc
Control | 0..1
Binding | For example codes, see ActionParticipantFunction (example to `http://hl7.org/fhir/ValueSet/action-participant-function|5.0.0` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. ActivityDefinition.product[x]
Definition | Identifies the food, drug or other product being consumed or supplied in the activity.
Short | What's administered/supplied
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationCodes (example to `http://hl7.org/fhir/ValueSet/medication-codes|5.0.0` ) Code describing the type of substance or medication.
Type | Choice of: Reference(Medication, Ingredient, Substance, SubstanceDefinition), CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. ActivityDefinition.quantity
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
Short | How much is administered/consumed/supplied
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | dose
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. ActivityDefinition.dosage
Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
Short | Detailed dosage instructions
Comments | If a dosage instruction is used, the definition should not specify timing or quantity.
Control | 0..*
Type | Dosage
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. ActivityDefinition.bodySite
Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
Short | What part of body to perform on
Comments | Only used if not implicit in the code found in ServiceRequest.type.
Control | 0..*
Binding | For example codes, see SNOMEDCTBodyStructures (example to `http://hl7.org/fhir/ValueSet/body-site|5.0.0` ) A code that identifies the anatomical location.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Knowing where the procedure is made is important for tracking if multiple sites are possible.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. ActivityDefinition.specimenRequirement
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed.
Short | What specimens are required to perform this laboratory procedure
Control | 0..*
Type | canonical(Laboratory IVD Specimen Definition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Needed to represent lab order definitions.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. ActivityDefinition.observationRequirement
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.
Short | What observations are required to perform this laboratory procedure
Control | 0..*
Type | canonical(Input Observation)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | Needed to represent observation definitions.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. ActivityDefinition.observationResultRequirement
Definition | Defines the observations that are expected to be produced by the laboratory procedure.
Short | What observations are produced by this laboratory procedure
Control | 0..*
Type | canonical(Laboratory Observation Definition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. ActivityDefinition.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.
Short | Transform to apply the template
Comments | Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
Control | 0..1
Type | canonical(StructureMap)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. ActivityDefinition.dynamicValue
Definition | Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
Short | Dynamic aspects of the definition
Comments | Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. ActivityDefinition.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.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
182. ActivityDefinition.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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. ActivityDefinition.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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | 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()`)
186. ActivityDefinition.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).
Short | The path to the element to be set dynamically
Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. ActivityDefinition.dynamicValue.expression
Definition | An expression specifying the value of the customized element.
Short | An expression that provides the dynamic value for the customization
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
Control | 1..1
Type | Expression
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)