ITB - Online appointment booking service
1.0.0 - Initial Release

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

Resource Profile: ActivityDefinitionPortal

Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-portal Version: 1.0.0
Active as of 2026-04-20 Computable Name: ActivityDefinitionPortal

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

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

Actor-specific obligations

  • WofPortalClient only needs to populate code.coding.code when submitting a known service type code.
  • WofPortalServer populates the full representation, including meta, presentation fields, kind, and the complete code structure.

This profile intentionally constrains base FHIR to define a stable and testable API contract for WOF Portal.

  • 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..* WofBaseActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... meta Σ 1..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... Slices for extension Content/Rules for all slices
.... extension:sortKey 0..1 integer Portal-specific sort key
URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/ext-sort-key
.... extension:campaigns 0..1 (Complex) Campaign identifiers for the service
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SOΣ 1..1 code Publication status of the service concept
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... date SOΣ 1..1 dateTime Business version date for the definition
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... description SOΣ 0..1 markdown Presentation description of the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... kind SOΣ 1..1 code Target request type for the service
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... code SOΣ 1..1 CodeableConcept Booking activity code for the service
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... Slices for coding SΣ 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
..... coding:serviceTypeId SΣ 1..1 Coding Coded representation of the service concept
...... system Σ 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍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.participant.​type Base required ActionParticipantType 📍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 WofBaseActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition WofBaseActivityDefinition
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
... title 1..1 string Human-readable title for the service
... status 1..1 code Publication status of the service concept
.... Slices for coding 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
...... display 0..0 Representation defined by the system
..... coding:serviceTypeId 1..1 Coding Coded representation of the service concept
...... system 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
...... display 0..0 Representation defined by the system
... timing[x] 0..0 When activity is to occur
... participant 0..0 Who should participate in the action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* WofBaseActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..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 SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... 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 Σ 0..* 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".
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sortKey 0..1 integer Portal-specific sort key
URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/ext-sort-key
.... extension:campaigns 0..1 (Complex) Campaign identifiers for the service
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the activity definition
... name ΣC 0..1 string Name for this activity definition (computer friendly)
... title SOΣ 1..1 string Human-readable title for the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... status ?!SOΣ 1..1 code Publication status of the service concept
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... date SOΣ 1..1 dateTime Business version date for the definition
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SOΣ 0..1 markdown Presentation description of the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... kind SOΣ 1..1 code Target request type for the service
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code SOΣ 1..1 CodeableConcept Booking activity code for the service
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
...... 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 WOF Connect service type code system
...... version Σ 0..1 string Version of the system - if relevant
...... code OΣ 0..1 code Service type identifier
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:serviceTypeId SΣ 1..1 Coding Coded representation of the service concept
...... 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 Σ 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
...... version Σ 0..1 string Version of the system - if relevant
...... code OΣ 0..1 code Service type identifier
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept

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.status Base required PublicationStatus 📍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.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 WofBaseActivityDefinition

Summary

Mandatory: 3 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* WofBaseActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... meta Σ 1..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... Slices for extension Content/Rules for all slices
.... extension:sortKey 0..1 integer Portal-specific sort key
URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/ext-sort-key
.... extension:campaigns 0..1 (Complex) Campaign identifiers for the service
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SOΣ 1..1 code Publication status of the service concept
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... date SOΣ 1..1 dateTime Business version date for the definition
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... description SOΣ 0..1 markdown Presentation description of the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... kind SOΣ 1..1 code Target request type for the service
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... code SOΣ 1..1 CodeableConcept Booking activity code for the service
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... Slices for coding SΣ 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
..... coding:serviceTypeId SΣ 1..1 Coding Coded representation of the service concept
...... system Σ 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍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.participant.​type Base required ActionParticipantType 📍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 WofBaseActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition WofBaseActivityDefinition
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
... title 1..1 string Human-readable title for the service
... status 1..1 code Publication status of the service concept
.... Slices for coding 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
...... display 0..0 Representation defined by the system
..... coding:serviceTypeId 1..1 Coding Coded representation of the service concept
...... system 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
...... display 0..0 Representation defined by the system
... timing[x] 0..0 When activity is to occur
... participant 0..0 Who should participate in the action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* WofBaseActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..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 SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... 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 Σ 0..* 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".
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sortKey 0..1 integer Portal-specific sort key
URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/ext-sort-key
.... extension:campaigns 0..1 (Complex) Campaign identifiers for the service
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the activity definition
... name ΣC 0..1 string Name for this activity definition (computer friendly)
... title SOΣ 1..1 string Human-readable title for the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... status ?!SOΣ 1..1 code Publication status of the service concept
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... date SOΣ 1..1 dateTime Business version date for the definition
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SOΣ 0..1 markdown Presentation description of the service
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... kind SOΣ 1..1 code Target request type for the service
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code SOΣ 1..1 CodeableConcept Booking activity code for the service
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..1 Coding Coded representation of the service concept
Slice: Unordered, Open by pattern:system
..... coding:All Slices Content/Rules for all slices
...... 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 WOF Connect service type code system
...... version Σ 0..1 string Version of the system - if relevant
...... code OΣ 0..1 code Service type identifier
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:serviceTypeId SΣ 1..1 Coding Coded representation of the service concept
...... 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 Σ 1..1 uri WOF Connect service type code system
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
...... version Σ 0..1 string Version of the system - if relevant
...... code OΣ 0..1 code Service type identifier
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base ActivityDefinition
SHALL:handle https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base ActivityDefinition
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept

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.status Base required PublicationStatus 📍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.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 WofBaseActivityDefinition

Summary

Mandatory: 3 elements
Prohibited: 4 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron