WOF Connect📍
0.1.1 - ci-build [WIP]

WOF Connect📍, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions

Resource Profile: Wof Connect ActivityDefinition

Official URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-activitydefinition Version: 0.1.1
Draft as of 2026-03-06 Computable Name: WofConnectActivityDefinition

ActivityDefinition represents what can be offered and booked as a service.

It answers the question: “What service is the patient booking?”

Scope and usage

  • Defines the type of service (e.g., examination, consultation, treatment).
  • Contains a booking activity code that uniquely identifies the service concept.
  • Provides stable metadata such as title and description for presentation and search.

Booking and interoperability principle:

  • Booking is performed using the activity code, not the resource id.
  • This follows the approach used in IHE Scheduling profiles.
  • The code represents a shared service concept that can be reused across installations and systems.

Important: The resource id is a technical identifier local to a FHIR server. It MUST NOT be used as a booking key.

ActivityDefinitionPortal describes the service concept only. It does not define:

  • which locations offer the service
  • which practitioners perform it
  • context-specific price or duration
  • availability, schedules, or bookable time slots

Those context-specific details are provided through Offer and related context resources.

Current name in Backoffice: Service

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
... meta Σ 0..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... code SΣ 1..1 code System the data originates from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... name ΣC 0..1 string Machine-friendly name
... title Σ 0..1 string Human-friendly title
... status ?!SΣ 1..1 code Publication status of this activity definition
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description SΣ 0..1 markdown Human-readable description of the service
... code SΣ 1..1 CodeableConcept Service type being offered
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... coding SΣ 1..* Coding Service type coding
..... system SΣ 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... code SΣ 1..1 code Service type code
..... display Σ 0..1 string Display for the service type code
.... text SΣ 0..1 string Text representation of the service type
... 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 Duration in minutes
..... value SΣ 1..1 decimal Numeric duration
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit display for the duration
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
Required Pattern: min
... participant S 1..* BackboneElement Who can perform the service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 code Type of participant
Binding: ActionParticipantType (required): The type of participant in the activity.
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
..... coding SΣ 1..* Coding Role coding
...... system SΣ 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... code SΣ 1..1 code Role code
...... display Σ 0..1 string Display for the role code
..... text Σ 0..1 string Text representation of the role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.timing[x]:timingDuration.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition If 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-4 error ActivityDefinition If 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-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
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

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
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... tag 1..* Coding Tags applied to this resource
..... system S 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... code S 1..1 code System the data originates from
... name 0..1 string Machine-friendly name
... status S 1..1 code Publication status of this activity definition
... description S 0..1 markdown Human-readable description of the service
... code S 1..1 CodeableConcept Service type being offered
.... coding S 1..* Coding Service type coding
..... system S 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... code S 1..1 code Service type code
..... display 0..1 string Display for the service type code
.... text S 0..1 string Text representation of the service type
... 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 Duration in minutes
..... value S 1..1 decimal Numeric duration
..... unit 1..1 string Unit display for the duration
..... system S 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S 1..1 code Coded form of the unit
Required Pattern: min
... participant S 1..* BackboneElement Who can perform the service
.... type S 1..1 code Type of participant
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
..... coding S 1..* Coding Role coding
...... system S 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... code S 1..1 code Role code
...... display 0..1 string Display for the role code
..... text 0..1 string Text representation of the role

doco Documentation for this format
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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... 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 SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code System the data originates from
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... 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
... extension 0..* Extension Additional content defined by implementations
... 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 ΣC 0..1 string Machine-friendly name
... title Σ 0..1 string Human-friendly title
... subtitle 0..1 string Subordinate title of the activity definition
... status ?!SΣ 1..1 code Publication status of this activity definition
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 Σ 0..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Σ 0..1 markdown Human-readable description of the service
... 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 Service type being offered
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 SΣ 1..* Coding Service type coding
..... 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 SΣ 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Service type code
..... display Σ 0..1 string Display for the service type code
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Text representation of the service type
... 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 Duration in minutes
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numeric duration
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit display for the duration
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
Required Pattern: min
... location 0..1 Reference(Location) Where it should happen
... participant S 1..* BackboneElement Who can perform the service
.... 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 S 1..1 code Type of participant
Binding: ActionParticipantType (required): The type of participant in the activity.
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
..... 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 SΣ 1..* Coding Role coding
...... 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 SΣ 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Role code
...... display Σ 0..1 string Display for the role code
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Text representation of the role
... 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(4.0.1) 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

Path Status Usage ValueSet Version Source
ActivityDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.timing[x]:timingDuration.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition If 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-4 error ActivityDefinition If 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-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
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: 16 elements(4 nested mandatory elements)
Must-Support: 21 elements

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
... meta Σ 0..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... code SΣ 1..1 code System the data originates from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... name ΣC 0..1 string Machine-friendly name
... title Σ 0..1 string Human-friendly title
... status ?!SΣ 1..1 code Publication status of this activity definition
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description SΣ 0..1 markdown Human-readable description of the service
... code SΣ 1..1 CodeableConcept Service type being offered
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
.... coding SΣ 1..* Coding Service type coding
..... system SΣ 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... code SΣ 1..1 code Service type code
..... display Σ 0..1 string Display for the service type code
.... text SΣ 0..1 string Text representation of the service type
... 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 Duration in minutes
..... value SΣ 1..1 decimal Numeric duration
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit display for the duration
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
Required Pattern: min
... participant S 1..* BackboneElement Who can perform the service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 code Type of participant
Binding: ActionParticipantType (required): The type of participant in the activity.
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
..... coding SΣ 1..* Coding Role coding
...... system SΣ 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... code SΣ 1..1 code Role code
...... display Σ 0..1 string Display for the role code
..... text Σ 0..1 string Text representation of the role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.timing[x]:timingDuration.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition If 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-4 error ActivityDefinition If 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-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
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

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
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... tag 1..* Coding Tags applied to this resource
..... system S 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... code S 1..1 code System the data originates from
... name 0..1 string Machine-friendly name
... status S 1..1 code Publication status of this activity definition
... description S 0..1 markdown Human-readable description of the service
... code S 1..1 CodeableConcept Service type being offered
.... coding S 1..* Coding Service type coding
..... system S 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... code S 1..1 code Service type code
..... display 0..1 string Display for the service type code
.... text S 0..1 string Text representation of the service type
... 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 Duration in minutes
..... value S 1..1 decimal Numeric duration
..... unit 1..1 string Unit display for the duration
..... system S 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S 1..1 code Coded form of the unit
Required Pattern: min
... participant S 1..* BackboneElement Who can perform the service
.... type S 1..1 code Type of participant
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
..... coding S 1..* Coding Role coding
...... system S 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... code S 1..1 code Role code
...... display 0..1 string Display for the role code
..... text 0..1 string Text representation of the role

doco Documentation for this format

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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles that this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... 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 SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code System the data originates from
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... 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
... extension 0..* Extension Additional content defined by implementations
... 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 ΣC 0..1 string Machine-friendly name
... title Σ 0..1 string Human-friendly title
... subtitle 0..1 string Subordinate title of the activity definition
... status ?!SΣ 1..1 code Publication status of this activity definition
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 Σ 0..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Σ 0..1 markdown Human-readable description of the service
... 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 Service type being offered
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 SΣ 1..* Coding Service type coding
..... 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 SΣ 1..1 uri Coding system for service type
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/service-type
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Service type code
..... display Σ 0..1 string Display for the service type code
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Text representation of the service type
... 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 Duration in minutes
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numeric duration
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit Σ 1..1 string Unit display for the duration
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
Required Pattern: min
... location 0..1 Reference(Location) Where it should happen
... participant S 1..* BackboneElement Who can perform the service
.... 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 S 1..1 code Type of participant
Binding: ActionParticipantType (required): The type of participant in the activity.
Required Pattern: practitioner
.... role S 1..1 CodeableConcept Role required to perform the service
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
..... 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 SΣ 1..* Coding Role coding
...... 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 SΣ 1..1 uri Coding system for role
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/practitioner-role
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Role code
...... display Σ 0..1 string Display for the role code
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Text representation of the role
... 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(4.0.1) 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

Path Status Usage ValueSet Version Source
ActivityDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.timing[x]:timingDuration.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition If 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-4 error ActivityDefinition If 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-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
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: 16 elements(4 nested mandatory elements)
Must-Support: 21 elements

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