Wof Portal
0.1.0 - ci-build [WIP]
Wof Portal
0.1.0 - ci-build [WIP]
Wof Portal, published by Service Well AB. 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/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-portal | Version: 0.1.0 | |||
| Draft as of 2026-03-17 | 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
code.coding.code when submitting a known service type code.meta, presentation fields, kind, and the complete code structure.Booking and interoperability principle:
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:
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  ActivityDefinition |
C | 0..* | ActivityDefinition | 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Σ | 1..1 | id | Server-managed resource version
| ||||||
 profile |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
  extension:sortKey |
0..1 | integer | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
 extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
| name |
SOΣC | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SOΣ | 1..1 | string | Human-readable title for the service
| ||||||
| status |
?!SOΣ | 1..1 | code | Publication status of the service concept Binding: PublicationStatus (required): The lifecycle status of an artifact.
| ||||||
| date |
SOΣ | 1..1 | dateTime | Business version date for the definition
| ||||||
| description |
SOΣ | 1..1 | markdown | Presentation description of the service
| ||||||
| 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
| ||||||
 code |
SOΣ | 1..1 | CodeableConcept | Booking activity code for the service Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
| ||||||
 coding |
Σ | 1..1 | Coding | Coded representation of the service concept | ||||||
| system |
Σ | 1..1 | uri | WOF Connect service type code system Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| code |
OΣ | 1..1 | code | Service type identifier
| ||||||
| text |
Σ | 0..1 | string | Display label for the service code | ||||||
| Documentation for this format | ||||||||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
ActivityDefinition | |||||||||
 meta |
1..1 | Meta | Metadata about the resource | |||||||
| versionId |
SO | 1..1 | id | Server-managed resource version
| ||||||
| profile |
SO | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
| implicitRules |
0..0 | A set of rules under which this content was created | ||||||||
| language |
0..0 | Language of the resource content | ||||||||
| contained |
0..0 | Contained, inline Resources | ||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:sortKey |
0..1 | integer | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
| extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
 modifierExtension |
0..0 | Extension | ||||||||
| url |
0..0 | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||||||
| identifier |
0..0 | Additional identifier for the activity definition | ||||||||
| version |
0..0 | Business version of the activity definition | ||||||||
| name |
SO | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SO | 1..1 | string | Human-readable title for the service
| ||||||
| subtitle |
0..0 | Subordinate title of the activity definition | ||||||||
| status |
SO | 1..1 | code | Publication status of the service concept
| ||||||
| experimental |
0..0 | For testing purposes, not real usage | ||||||||
| subject[x] |
0..0 | Type of individual the activity definition is intended for | ||||||||
| date |
SO | 1..1 | dateTime | Business version date for the definition
| ||||||
| publisher |
0..0 | Name of the publisher (organization or individual) | ||||||||
| contact |
0..0 | Contact details for the publisher | ||||||||
| description |
SO | 1..1 | markdown | Presentation description of the service
| ||||||
| useContext |
0..0 | The context that the content is intended to support | ||||||||
| jurisdiction |
0..0 | Intended jurisdiction for activity definition (if applicable) | ||||||||
| purpose |
0..0 | Why this activity definition is defined | ||||||||
| usage |
0..0 | Describes the clinical usage of the activity definition | ||||||||
| copyright |
0..0 | Use and/or publishing restrictions | ||||||||
| approvalDate |
0..0 | When the activity definition was approved by publisher | ||||||||
| lastReviewDate |
0..0 | When the activity definition was last reviewed | ||||||||
| effectivePeriod |
0..0 | When the activity definition is expected to be used | ||||||||
| topic |
0..0 | E.g. Education, Treatment, Assessment, etc. | ||||||||
| author |
0..0 | Who authored the content | ||||||||
| editor |
0..0 | Who edited the content | ||||||||
| reviewer |
0..0 | Who reviewed the content | ||||||||
| endorser |
0..0 | Who endorsed the content | ||||||||
| relatedArtifact |
0..0 | Additional documentation, citations, etc. | ||||||||
| library |
0..0 | Logic used by the activity definition | ||||||||
| kind |
SO | 1..1 | code | Target request type for the service Required Pattern: ServiceRequest
| ||||||
| code |
SO | 1..1 | CodeableConcept | Booking activity code for the service
| ||||||
| coding |
1..1 | Coding | Coded representation of the service concept | |||||||
| system |
1..1 | uri | WOF Connect service type code system Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | |||||||
| code |
O | 1..1 | code | Service type identifier
| ||||||
| text |
0..1 | string | Display label for the service code | |||||||
| intent |
0..0 | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||||||
| priority |
0..0 | routine | urgent | asap | stat | ||||||||
| doNotPerform |
0..0 | True if the activity should not be performed | ||||||||
| timing[x] |
0..0 | When activity is to occur | ||||||||
| location |
0..0 | Where it should happen | ||||||||
| participant |
0..0 | Who should participate in the action | ||||||||
| product[x] |
0..0 | What's administered/supplied | ||||||||
| quantity |
0..0 | How much is administered/consumed/supplied | ||||||||
| dosage |
0..0 | Detailed dosage instructions | ||||||||
| bodySite |
0..0 | What part of body to perform on | ||||||||
| specimenRequirement |
0..0 | What specimens are required to perform this action | ||||||||
| observationRequirement |
0..0 | What observations are required to perform this action | ||||||||
| observationResultRequirement |
0..0 | What observations must be produced by this action | ||||||||
| transform |
0..0 | Transform to apply the template | ||||||||
| dynamicValue |
0..0 | Dynamic aspects of the definition | ||||||||
| Documentation for this format | ||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | ActivityDefinition | 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Σ | 1..1 | id | Server-managed resource version
| ||||||
| 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
| ||||||
| 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 | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
| extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
| name |
SOΣC | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SOΣ | 1..1 | string | Human-readable title for the service
| ||||||
| status |
?!SOΣ | 1..1 | code | Publication status of the service concept Binding: PublicationStatus (required): The lifecycle status of an artifact.
| ||||||
| date |
SOΣ | 1..1 | dateTime | Business version date for the definition
| ||||||
| description |
SOΣ | 1..1 | markdown | Presentation description of the service
| ||||||
| 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
| ||||||
| 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.
| ||||||
| 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 |
Σ | 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 Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
OΣ | 1..1 | code | Service type identifier
| ||||||
| 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 | Display label for the service code | ||||||
| Documentation for this format | ||||||||||
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | ActivityDefinition | 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Σ | 1..1 | id | Server-managed resource version
| ||||||
| profile |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:sortKey |
0..1 | integer | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
| extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
| name |
SOΣC | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SOΣ | 1..1 | string | Human-readable title for the service
| ||||||
| status |
?!SOΣ | 1..1 | code | Publication status of the service concept Binding: PublicationStatus (required): The lifecycle status of an artifact.
| ||||||
| date |
SOΣ | 1..1 | dateTime | Business version date for the definition
| ||||||
| description |
SOΣ | 1..1 | markdown | Presentation description of the service
| ||||||
| 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
| ||||||
| code |
SOΣ | 1..1 | CodeableConcept | Booking activity code for the service Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
| ||||||
| coding |
Σ | 1..1 | Coding | Coded representation of the service concept | ||||||
| system |
Σ | 1..1 | uri | WOF Connect service type code system Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| code |
OΣ | 1..1 | code | Service type identifier
| ||||||
| text |
Σ | 0..1 | string | Display label for the service code | ||||||
| Documentation for this format | ||||||||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
ActivityDefinition | |||||||||
| meta |
1..1 | Meta | Metadata about the resource | |||||||
| versionId |
SO | 1..1 | id | Server-managed resource version
| ||||||
| profile |
SO | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
| implicitRules |
0..0 | A set of rules under which this content was created | ||||||||
| language |
0..0 | Language of the resource content | ||||||||
| contained |
0..0 | Contained, inline Resources | ||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:sortKey |
0..1 | integer | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
| extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
| modifierExtension |
0..0 | Extension | ||||||||
| url |
0..0 | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||||||
| identifier |
0..0 | Additional identifier for the activity definition | ||||||||
| version |
0..0 | Business version of the activity definition | ||||||||
| name |
SO | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SO | 1..1 | string | Human-readable title for the service
| ||||||
| subtitle |
0..0 | Subordinate title of the activity definition | ||||||||
| status |
SO | 1..1 | code | Publication status of the service concept
| ||||||
| experimental |
0..0 | For testing purposes, not real usage | ||||||||
| subject[x] |
0..0 | Type of individual the activity definition is intended for | ||||||||
| date |
SO | 1..1 | dateTime | Business version date for the definition
| ||||||
| publisher |
0..0 | Name of the publisher (organization or individual) | ||||||||
| contact |
0..0 | Contact details for the publisher | ||||||||
| description |
SO | 1..1 | markdown | Presentation description of the service
| ||||||
| useContext |
0..0 | The context that the content is intended to support | ||||||||
| jurisdiction |
0..0 | Intended jurisdiction for activity definition (if applicable) | ||||||||
| purpose |
0..0 | Why this activity definition is defined | ||||||||
| usage |
0..0 | Describes the clinical usage of the activity definition | ||||||||
| copyright |
0..0 | Use and/or publishing restrictions | ||||||||
| approvalDate |
0..0 | When the activity definition was approved by publisher | ||||||||
| lastReviewDate |
0..0 | When the activity definition was last reviewed | ||||||||
| effectivePeriod |
0..0 | When the activity definition is expected to be used | ||||||||
| topic |
0..0 | E.g. Education, Treatment, Assessment, etc. | ||||||||
| author |
0..0 | Who authored the content | ||||||||
| editor |
0..0 | Who edited the content | ||||||||
| reviewer |
0..0 | Who reviewed the content | ||||||||
| endorser |
0..0 | Who endorsed the content | ||||||||
| relatedArtifact |
0..0 | Additional documentation, citations, etc. | ||||||||
| library |
0..0 | Logic used by the activity definition | ||||||||
| kind |
SO | 1..1 | code | Target request type for the service Required Pattern: ServiceRequest
| ||||||
| code |
SO | 1..1 | CodeableConcept | Booking activity code for the service
| ||||||
| coding |
1..1 | Coding | Coded representation of the service concept | |||||||
| system |
1..1 | uri | WOF Connect service type code system Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | |||||||
| code |
O | 1..1 | code | Service type identifier
| ||||||
| text |
0..1 | string | Display label for the service code | |||||||
| intent |
0..0 | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||||||
| priority |
0..0 | routine | urgent | asap | stat | ||||||||
| doNotPerform |
0..0 | True if the activity should not be performed | ||||||||
| timing[x] |
0..0 | When activity is to occur | ||||||||
| location |
0..0 | Where it should happen | ||||||||
| participant |
0..0 | Who should participate in the action | ||||||||
| product[x] |
0..0 | What's administered/supplied | ||||||||
| quantity |
0..0 | How much is administered/consumed/supplied | ||||||||
| dosage |
0..0 | Detailed dosage instructions | ||||||||
| bodySite |
0..0 | What part of body to perform on | ||||||||
| specimenRequirement |
0..0 | What specimens are required to perform this action | ||||||||
| observationRequirement |
0..0 | What observations are required to perform this action | ||||||||
| observationResultRequirement |
0..0 | What observations must be produced by this action | ||||||||
| transform |
0..0 | Transform to apply the template | ||||||||
| dynamicValue |
0..0 | Dynamic aspects of the definition | ||||||||
| Documentation for this format | ||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | ActivityDefinition | 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Σ | 1..1 | id | Server-managed resource version
| ||||||
| 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
| ||||||
| 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 | Sort Key URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-sort-key | |||||||
| extension:campaigns |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Campaigns URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-campaigns | |||||||
| name |
SOΣC | 1..1 | string | Machine-friendly name for the service concept
| ||||||
| title |
SOΣ | 1..1 | string | Human-readable title for the service
| ||||||
| status |
?!SOΣ | 1..1 | code | Publication status of the service concept Binding: PublicationStatus (required): The lifecycle status of an artifact.
| ||||||
| date |
SOΣ | 1..1 | dateTime | Business version date for the definition
| ||||||
| description |
SOΣ | 1..1 | markdown | Presentation description of the service
| ||||||
| 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
| ||||||
| 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.
| ||||||
| 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 |
Σ | 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 Fixed Value: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
OΣ | 1..1 | code | Service type identifier
| ||||||
| 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 | Display label for the service code | ||||||
| Documentation for this format | ||||||||||
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron