ITB Implementation Guide
0.1.0 - Release Label

ITB Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/espen-servicewell/wof-portal-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ITB ActivityDefinition

Official URL: http://portal.wof.purified.link/fhir/StructureDefinition/ITBActivityDefinition Version: 0.1.0
Draft as of 2025-08-20 Computable Name: ITBActivityDefinition

ITBActivityDefinition is used to handle ..

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... name SΣC 1..1 string Name for this activity definition (computer friendly)
... title SΣ 1..1 string Title for this activity definition (human friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... date SΣ 1..1 dateTime Date last changed
... description SΣ 1..1 markdown Natural language description of the activity definition
... code SΣ 1..1 CodeableConcept ServiceTypeCode
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... coding Σ 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Closed by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... name S 1..1 string Name for this activity definition (computer friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status S 1..1 code draft | active | retired | unknown
... date S 1..1 dateTime Date last changed
... description S 1..1 markdown Natural language description of the activity definition
... code S 1..1 CodeableConcept ServiceTypeCode
.... coding 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Open by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id SΣ 1..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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... version Σ 0..1 string Business version of the activity definition
... name SΣC 1..1 string Name for this activity definition (computer friendly)
... title SΣ 1..1 string Title for this activity definition (human friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status ?!SΣ 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: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..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: Jurisdiction ValueSet (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 string Describes the clinical usage of the activity definition
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the activity definition was approved by publisher
... lastReviewDate 0..1 date When the activity definition was last reviewed
... effectivePeriod Σ 0..1 Period When the activity definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
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 Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code SΣ 1..1 CodeableConcept ServiceTypeCode
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 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.
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Closed by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... location 0..1 Reference(Location) Where it should happen
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... 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 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
... product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
.... productReference Reference(Medication | Substance)
.... productCodeableConcept CodeableConcept
... quantity 0..1 SimpleQuantity 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 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
... observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
... observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard
ActivityDefinition.kindrequiredRequestResourceType
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
From the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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: 11 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.timing[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... name SΣC 1..1 string Name for this activity definition (computer friendly)
... title SΣ 1..1 string Title for this activity definition (human friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... date SΣ 1..1 dateTime Date last changed
... description SΣ 1..1 markdown Natural language description of the activity definition
... code SΣ 1..1 CodeableConcept ServiceTypeCode
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... coding Σ 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Closed by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... name S 1..1 string Name for this activity definition (computer friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status S 1..1 code draft | active | retired | unknown
... date S 1..1 dateTime Date last changed
... description S 1..1 markdown Natural language description of the activity definition
... code S 1..1 CodeableConcept ServiceTypeCode
.... coding 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Open by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id SΣ 1..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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:OpusBookingCategoryExtension 0..* string Opus Booking Category Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusBookingCategory
.... extension:OpusCryptobookingTextExtension 0..* string OpusCryptobookingText Extension
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extOpusCryptobookingText
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... version Σ 0..1 string Business version of the activity definition
... name SΣC 1..1 string Name for this activity definition (computer friendly)
... title SΣ 1..1 string Title for this activity definition (human friendly)
... subtitle S 1..1 string Subordinate title of the activity definition
... status ?!SΣ 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: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..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: Jurisdiction ValueSet (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 string Describes the clinical usage of the activity definition
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the activity definition was approved by publisher
... lastReviewDate 0..1 date When the activity definition was last reviewed
... effectivePeriod Σ 0..1 Period When the activity definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
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 Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code SΣ 1..1 CodeableConcept ServiceTypeCode
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
Binding: ITB Service Types (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://portal.wof.purified.link/fhir/CodeSystem/csServiceType
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 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.
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... Slices for timing[x] 1..1 Duration When activity is to occur
Slice: Unordered, Closed by type:$this
.... timing[x]:timingDuration S 1..1 Duration Code for the Activity that is to be performed
... location 0..1 Reference(Location) Where it should happen
... participant S 1..1 BackboneElement The role that is requered to perform this activity
.... 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 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role S 1..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
... product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
.... productReference Reference(Medication | Substance)
.... productCodeableConcept CodeableConcept
... quantity 0..1 SimpleQuantity 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 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
... observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
... observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard
ActivityDefinition.kindrequiredRequestResourceType
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.code.codingrequiredITBServiceType
http://portal.wof.purified.link/fhir/ValueSet/service-type
From this IG
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
From the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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: 11 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.timing[x]

 

Other representations of profile: CSV, Excel, Schematron