Order Catalog Implementation Guide
current - CI Build International flag

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

Resource Profile: LabProcedureDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition Version: current
Draft as of 2023-07-08 Computable Name: LabProcedureDefinition

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... url 1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... title S0..1stringName for this activity definition (human friendly)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... date S0..1dateTimeDate last changed
... contact
.... telecom S0..*ContactPointContact details for individual or organization
... description S0..1markdownNatural language description of the activity definition
... effectivePeriod
.... start S0..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
... kind 1..1codeKind of resource
Fixed Value: ServiceRequest
... code S0..1CodeableConceptDetail type of activity
.... Slices for coding 0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC S0..1CodingLOINC code for the laboratory procedure
...... system S0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
... doNotPerform 0..0
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... title SΣ0..1stringName for this activity definition (human friendly)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
.... telecom SΣ0..*ContactPointContact details for individual or organization
... description SΣ0..1markdownNatural language description of the activity definition
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... kind Σ1..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.


Fixed Value: ServiceRequest
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

.... Slices for coding Σ0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC SΣ0..1CodingLOINC code for the laboratory procedure
...... system SΣ0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredFixed Value: ServiceRequest
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName 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-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this activity definition (computer friendly)
... title SΣ0..1stringName for this activity definition (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date SΣ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ0..1stringName of an individual to contact
.... telecom SΣ0..*ContactPointContact details for individual or organization
... description SΣ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... library 0..*canonical(Library)Logic used by the activity definition
... kind Σ1..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.


Fixed Value: ServiceRequest
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC SΣ0..1CodingLOINC code for the laboratory procedure
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code ΣC0..1codeSymbol in syntax defined by the system
...... display ΣC0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

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

.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ActivityDefinition.languagerequiredAllLanguages
ActivityDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleParticipantResourceTypes
ActivityDefinition.jurisdictionextensibleJurisdictionValueSet
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredFixed Value: ServiceRequest
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.participant.functionexampleActionParticipantFunction
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
cnl-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element ActivityDefinition.code.coding is sliced based on the value of value:system

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... url 1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... title S0..1stringName for this activity definition (human friendly)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... date S0..1dateTimeDate last changed
... contact
.... telecom S0..*ContactPointContact details for individual or organization
... description S0..1markdownNatural language description of the activity definition
... effectivePeriod
.... start S0..1dateTimeStarting time with inclusive boundary
.... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
... kind 1..1codeKind of resource
Fixed Value: ServiceRequest
... code S0..1CodeableConceptDetail type of activity
.... Slices for coding 0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC S0..1CodingLOINC code for the laboratory procedure
...... system S0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
... doNotPerform 0..0
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... title SΣ0..1stringName for this activity definition (human friendly)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
.... telecom SΣ0..*ContactPointContact details for individual or organization
... description SΣ0..1markdownNatural language description of the activity definition
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... kind Σ1..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.


Fixed Value: ServiceRequest
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

.... Slices for coding Σ0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC SΣ0..1CodingLOINC code for the laboratory procedure
...... system SΣ0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredFixed Value: ServiceRequest
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName 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-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this activity definition (computer friendly)
... title SΣ0..1stringName for this activity definition (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date SΣ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ0..1stringName of an individual to contact
.... telecom SΣ0..*ContactPointContact details for individual or organization
... description SΣ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeStarting time with inclusive boundary
.... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic S0..*CodeableConceptCategorization of the laboratory procedure
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... library 0..*canonical(Library)Logic used by the activity definition
... kind Σ1..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.


Fixed Value: ServiceRequest
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode for the laboratory procedure
Slice: Unordered, Open by value:system
..... coding:orderCodeLOINC SΣ0..1CodingLOINC code for the laboratory procedure
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ0..1uriLOINC test code for this activity
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code ΣC0..1codeSymbol in syntax defined by the system
...... display ΣC0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)The physical sector of the laboratory performing the procedure
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

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

.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement S0..*canonical(Laboratory IVD Specimen Definition)What specimens are required to perform this laboratory procedure
... observationRequirement S0..*canonical(Input Observation)What observations are required to perform this laboratory procedure
... observationResultRequirement S0..*canonical(Laboratory Observation Definition)What observations are produced by this laboratory procedure
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ActivityDefinition.languagerequiredAllLanguages
ActivityDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleParticipantResourceTypes
ActivityDefinition.jurisdictionextensibleJurisdictionValueSet
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredFixed Value: ServiceRequest
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.participant.functionexampleActionParticipantFunction
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
cnl-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element ActivityDefinition.code.coding is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron