Order Catalog Implementation Guide
1.0.0 - STU 1

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

## Resource Profile: LabProcedureDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: LabProcedureDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.55.42.17

This profile constrains ActivityDefinition to represent the definition of a laboratory diagnostic procedure (test or panel) to be performed on one or more biological/digital specimens. The ActivityDefinition resource declares the observations that are expected as input to the procedure, the kinds of specimens to be collected, and the observations produced as output. Such a definition can be used in a laboratory compendium as well as in other contexts.

ActivityDefinition defines the various pieces of the definition of a laboratory procedure, such as input observations and biological/material specimens and output observations. For this purpose ActivityDefinition references instances of ObservationDefinition and SpecimenDefinition.

Usages:

- Refer to this Profile: Laboratory Service Definition
- Examples for this Profile: BloodElectrolyteProcedure, CMVProcedure, HSVProcedure, HSVT1Procedure... Show 8 more, HSVT2Procedure, PotassiumSerumMeasurementProcedure, RubellaProcedure, UrineCreatinineProcedure, ToxoplasmaProcedure, VitaminDProcedure, UrineCreatinineClearanceProcedure and UrineCreatinineProcedure

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: cnl-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) Constraints: cnl-1
title | S Σ | 0..1 | string | Name for this activity definition (human friendly)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date | S Σ | 0..1 | dateTime | Date last changed
publisher | S Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or organization
description | S Σ | 0..1 | markdown | Natural language description of the activity definition
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
kind | Σ | 1..1 | code | Kind of resource Binding: RequestResourceTypes (required): The kind of activity the definition is describing. Required Pattern: ServiceRequest
code | S Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
Slices for coding | Σ | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory procedure
system | S Σ | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ActivityDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
ActivityDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
ActivityDefinition.kind | Base | required | Request Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | ActivityDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from ActivityDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition |  | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context
url |  | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique)
title | S | 0..1 | string | Name for this activity definition (human friendly)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
date | S | 0..1 | dateTime | Date last changed
publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual)
contact |  |  |  |
telecom | S | 0..* | ContactPoint | Contact details for individual or organization
description | S | 0..1 | markdown | Natural language description of the activity definition
effectivePeriod |  |  |  |
start | S | 0..1 | dateTime | Starting time with inclusive boundary
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure
kind |  | 1..1 | code | Kind of resource Required Pattern: ServiceRequest
code | S | 0..1 | CodeableConcept | Detail type of activity
Slices for coding |  | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S | 0..1 | Coding | LOINC code for the laboratory procedure
system | S | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
doNotPerform |  | 0..0 |  | True if the activity should not be performed
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: cnl-0
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) Constraints: cnl-1
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition
version | Σ | 0..1 | string | Business version of the activity definition
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this activity definition (computer friendly)
title | S Σ | 0..1 | string | Name for this activity definition (human friendly)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
subtitle |  | 0..1 | string | Subordinate title of the activity definition
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
subject[x] |  | 0..1 |  | Type of individual the activity definition is intended for Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) |
subjectCanonical |  |  | canonical(EvidenceVariable) |
date | S Σ | 0..1 | dateTime | Date last changed
publisher | S Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
name | Σ | 0..1 | string | Name of an individual to contact
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or organization
description | S Σ | 0..1 | markdown | Natural language description of the activity definition
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this activity definition is defined
usage |  | 0..1 | markdown | Describes the clinical usage of the activity definition
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
approvalDate |  | 0..1 | date | When the activity definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the activity definition was last reviewed by the publisher
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
relatedArtifact |  | 0..* | RelatedArtifact | Additional documentation, citations, etc
library |  | 0..* | canonical(Library) | Logic used by the activity definition
kind | Σ | 1..1 | code | Kind of resource Binding: RequestResourceTypes (required): The kind of activity the definition is describing. Required Pattern: ServiceRequest
profile |  | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to
code | S Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory procedure
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 0..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
intent |  | 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
timing[x] |  | 0..1 |  | When activity is to occur
timingTiming |  |  | Timing |
timingAge |  |  | Age |
timingRange |  |  | Range |
timingDuration |  |  | Duration |
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: Action Participant Role (example): Defines roles played by participants for the action.
function |  | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example)
product[x] |  | 0..1 |  | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
productReference |  |  | Reference(Medication | Ingredient | Substance | SubstanceDefinition) |
productCodeableConcept |  |  | CodeableConcept |
quantity |  | 0..1 | SimpleQuantity(5.0.0) | How much is administered/consumed/supplied
dosage |  | 0..* | Dosage | Detailed dosage instructions
bodySite |  | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 1..1 | string | The path to the element to be set dynamically
expression |  | 1..1 | Expression | An expression that provides the dynamic value for the customization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ActivityDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
ActivityDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std.
ActivityDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
ActivityDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std.
ActivityDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
ActivityDefinition.kind | Base | required | Request Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍5.0.0 | FHIR Std.
ActivityDefinition.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std.
ActivityDefinition.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
ActivityDefinition.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std.
ActivityDefinition.participant.​type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
ActivityDefinition.participant.​role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
ActivityDefinition.participant.​function | Base | example | Action Participant Function | 📍5.0.0 | FHIR Std.
ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std.
ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | ActivityDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from ActivityDefinition

Summary

Mandatory: 2 elements
Must-Support: 14 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- Laboratory IVD Specimen Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition)
- Input Observation (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/InputObservationDefinition)
- Laboratory Observation Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/translation

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ActivityDefinition.code.coding

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: cnl-0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) Constraints: cnl-1
title | S Σ | 0..1 | string | Name for this activity definition (human friendly)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date | S Σ | 0..1 | dateTime | Date last changed
publisher | S Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or organization
description | S Σ | 0..1 | markdown | Natural language description of the activity definition
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
kind | Σ | 1..1 | code | Kind of resource Binding: RequestResourceTypes (required): The kind of activity the definition is describing. Required Pattern: ServiceRequest
code | S Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
Slices for coding | Σ | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory procedure
system | S Σ | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ActivityDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
ActivityDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
ActivityDefinition.kind | Base | required | Request Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | ActivityDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from ActivityDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition |  | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context
url |  | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique)
title | S | 0..1 | string | Name for this activity definition (human friendly)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
date | S | 0..1 | dateTime | Date last changed
publisher | S | 0..1 | string | Name of the publisher/steward (organization or individual)
contact |  |  |  |
telecom | S | 0..* | ContactPoint | Contact details for individual or organization
description | S | 0..1 | markdown | Natural language description of the activity definition
effectivePeriod |  |  |  |
start | S | 0..1 | dateTime | Starting time with inclusive boundary
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure
kind |  | 1..1 | code | Kind of resource Required Pattern: ServiceRequest
code | S | 0..1 | CodeableConcept | Detail type of activity
Slices for coding |  | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S | 0..1 | Coding | LOINC code for the laboratory procedure
system | S | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
doNotPerform |  | 0..0 |  | True if the activity should not be performed
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: cnl-0
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
url | Σ C | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) Constraints: cnl-1
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition
version | Σ | 0..1 | string | Business version of the activity definition
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this activity definition (computer friendly)
title | S Σ | 0..1 | string | Name for this activity definition (human friendly)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:OtherTitle |  | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation
value |  | 0..1 | string | Primitive value for string Max Length:1048576
subtitle |  | 0..1 | string | Subordinate title of the activity definition
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
subject[x] |  | 0..1 |  | Type of individual the activity definition is intended for Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) |
subjectCanonical |  |  | canonical(EvidenceVariable) |
date | S Σ | 0..1 | dateTime | Date last changed
publisher | S Σ | 0..1 | string | Name of the publisher/steward (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
name | Σ | 0..1 | string | Name of an individual to contact
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or organization
description | S Σ | 0..1 | markdown | Natural language description of the activity definition
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this activity definition is defined
usage |  | 0..1 | markdown | Describes the clinical usage of the activity definition
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
approvalDate |  | 0..1 | date | When the activity definition was approved by publisher
lastReviewDate |  | 0..1 | date | When the activity definition was last reviewed by the publisher
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
topic | S | 0..* | CodeableConcept | Categorization of the laboratory procedure Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
relatedArtifact |  | 0..* | RelatedArtifact | Additional documentation, citations, etc
library |  | 0..* | canonical(Library) | Logic used by the activity definition
kind | Σ | 1..1 | code | Kind of resource Binding: RequestResourceTypes (required): The kind of activity the definition is describing. Required Pattern: ServiceRequest
profile |  | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to
code | S Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code for the laboratory procedure Slice: Unordered, Open by value:system
coding:orderCodeLOINC | S Σ | 0..1 | Coding | LOINC code for the laboratory procedure
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | LOINC test code for this activity Required Pattern: http://loinc.org
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 0..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
intent |  | 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
timing[x] |  | 0..1 |  | When activity is to occur
timingTiming |  |  | Timing |
timingAge |  |  | Age |
timingRange |  |  | Range |
timingDuration |  |  | Duration |
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
location |  | 0..1 | CodeableReference(Location) | The physical sector of the laboratory performing the procedure
participant |  | 0..* | BackboneElement | Who should participate in the action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity.
typeCanonical |  | 0..1 | canonical(CapabilityStatement) | Who or what can participate
typeReference |  | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
role |  | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: Action Participant Role (example): Defines roles played by participants for the action.
function |  | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example)
product[x] |  | 0..1 |  | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
productReference |  |  | Reference(Medication | Ingredient | Substance | SubstanceDefinition) |
productCodeableConcept |  |  | CodeableConcept |
quantity |  | 0..1 | SimpleQuantity(5.0.0) | How much is administered/consumed/supplied
dosage |  | 0..* | Dosage | Detailed dosage instructions
bodySite |  | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
specimenRequirement | S | 0..* | canonical(Laboratory IVD Specimen Definition) | What specimens are required to perform this laboratory procedure
observationRequirement | S | 0..* | canonical(Input Observation) | What observations are required to perform this laboratory procedure
observationResultRequirement | S | 0..* | canonical(Laboratory Observation Definition) | What observations are produced by this laboratory procedure
transform |  | 0..1 | canonical(StructureMap) | Transform to apply the template
dynamicValue |  | 0..* | BackboneElement | Dynamic aspects of the definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
path |  | 1..1 | string | The path to the element to be set dynamically
expression |  | 1..1 | Expression | An expression that provides the dynamic value for the customization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ActivityDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
ActivityDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std.
ActivityDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std.
ActivityDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std.
ActivityDefinition.topic | Base | example | Definition Topic | 📍5.0.0 | FHIR Std.
ActivityDefinition.kind | Base | required | Request Resource Types | 📍5.0.0 | FHIR Std.
ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍5.0.0 | FHIR Std.
ActivityDefinition.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std.
ActivityDefinition.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std.
ActivityDefinition.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std.
ActivityDefinition.participant.​type | Base | required | Action Participant Type | 📍5.0.0 | FHIR Std.
ActivityDefinition.participant.​role | Base | example | Action Participant Role | 📦2.0.0 | THO v7.1
ActivityDefinition.participant.​function | Base | example | Action Participant Function | 📍5.0.0 | FHIR Std.
ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std.
ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cnl-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation | `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
cnl-1 | warning | ActivityDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | `exists() implies matches('^[^|# ]+$')`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from ActivityDefinition

Summary

Mandatory: 2 elements
Must-Support: 14 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- Laboratory IVD Specimen Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition)
- Input Observation (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/InputObservationDefinition)
- Laboratory Observation Definition (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/translation

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ActivityDefinition.code.coding

Maturity: 2

Other representations of profile: CSV, Excel, Schematron