0.1.0 - ci-build

WofPortalIG, 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

Resource Profile: OfferPortal

Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/offer-portal Version: 0.1.0
Draft as of 2026-02-05 Computable Name: OfferPortal

OfferPortal represents a bookable offering in a specific context.

It answers the question: “Which service can be booked, by whom, and where — and what are the booking-facing settings in that context?”

  • Connects an ActivityDefinitionPortal (what) with a HealthcareServicePortal (where) and a PractitionerRolePortal (who).
  • Represents the context-specific configuration for booking content.
  • Is intended as a lightweight object for frontends to render booking options quickly.

An OfferPortal contains references to:

  • activityDefinition — Reference(ActivityDefinitionPortal)
  • healthcareService — Reference(HealthcareServicePortal)
  • practitionerRole — Reference(PractitionerRolePortal)

OfferPortal may include booking-facing settings such as:

  • duration — free-text (presentation value)
  • price — free-text (presentation value)
  • bookingUrl — deeplink for booking

Important: OfferPortal does not represent real-time availability. It does not include schedules, working hours, or bookable time slots.

OfferPortal is a context/read model intended to support fast, “chatty” consumption. It is not a replacement for scheduling or billing workflows.

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
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:offering ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: offering
..... Slices for part Σ 3..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:activityDefinition Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] ΣC 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
...... part:healthcareService Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] ΣC 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
...... part:practitionerRole Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] ΣC 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
...... part:duration Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: duration
....... value[x] ΣC 0..1 string If parameter is a data type
...... part:price Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: price
....... value[x] ΣC 0..1 string If parameter is a data type
...... part:bookingUrl Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] ΣC 0..1 url If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()
inv-1 error Parameters.parameter, Parameters.parameter:offering A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:offering 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: offering
..... Slices for part 3..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:activityDefinition 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
...... part:healthcareService 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
...... part:practitionerRole 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
...... part:duration 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: duration
....... value[x] 0..1 string If parameter is a data type
...... part:price 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: price
....... value[x] 0..1 string If parameter is a data type
...... part:bookingUrl 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] 0..1 url If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter: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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:offering ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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
..... name Σ 1..1 string Name from the definition
Fixed Value: offering
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part Σ 3..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part: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
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:activityDefinition Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] ΣC 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:healthcareService Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] ΣC 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:practitionerRole Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] ΣC 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:duration Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: duration
....... value[x] ΣC 0..1 string If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:price Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: price
....... value[x] ΣC 0..1 string If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:bookingUrl Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] ΣC 0..1 url If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-1 error Parameters.parameter, Parameters.parameter:offering A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 5 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:offering ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: offering
..... Slices for part Σ 3..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:activityDefinition Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] ΣC 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
...... part:healthcareService Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] ΣC 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
...... part:practitionerRole Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] ΣC 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
...... part:duration Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: duration
....... value[x] ΣC 0..1 string If parameter is a data type
...... part:price Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: price
....... value[x] ΣC 0..1 string If parameter is a data type
...... part:bookingUrl Σ 0..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] ΣC 0..1 url If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()
inv-1 error Parameters.parameter, Parameters.parameter:offering A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:offering 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: offering
..... Slices for part 3..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:activityDefinition 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
...... part:healthcareService 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
...... part:practitionerRole 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
...... part:duration 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: duration
....... value[x] 0..1 string If parameter is a data type
...... part:price 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: price
....... value[x] 0..1 string If parameter is a data type
...... part:bookingUrl 0..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] 0..1 url If parameter is a data type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter: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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:offering ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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
..... name Σ 1..1 string Name from the definition
Fixed Value: offering
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part Σ 3..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part: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
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:activityDefinition Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: activityDefinition
....... value[x] ΣC 0..1 ActivityDefinitionPortal() The definition of a specific activity to be taken, independent of any particular patient or context
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:healthcareService Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: healthcareService
....... value[x] ΣC 0..1 HealthcareServicePortal() The details of a healthcare service available at a location
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:practitionerRole Σ 1..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: practitionerRole
....... value[x] ΣC 0..1 PractitionerRolePortal() Roles/organizations the practitioner is associated with
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:duration Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: duration
....... value[x] ΣC 0..1 string If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:price Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: price
....... value[x] ΣC 0..1 string If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:bookingUrl Σ 0..1 BackboneElement Named part of a multi-part parameter
....... 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
....... name Σ 1..1 string Name from the definition
Fixed Value: bookingUrl
....... value[x] ΣC 0..1 url If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
inv-1 error Parameters.parameter, Parameters.parameter:offering A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 5 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

 

Other representations of profile: CSV, Excel, Schematron