ITB - Online appointment booking service
1.0.1 - Documentation update

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.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

Resource Profile: Portal Patient

Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-patient Version: 1.0.1
Active as of 2026-06-09 Computable Name: PortalPatient

Representation of a patient in Wof-portal public API system.

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
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... id SΣ 0..1 id Internal identifier
... meta Σ 0..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 Patient
.... 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 Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
.... identifier:All Slices Content/Rules for all slices
.... identifier:personalNumber Σ 1..1 Identifier National personal number for the patient
..... system Σ 1..1 uri System that issued the personal number
Binding: Allowed Personal Number Identifier Systems (extensible)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Personal number value
Example General: 123456
.... identifier:sourceSystemIdentifier SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... name Σ 1..1 HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom Σ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SΣC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:personalNumber.​system Base extensible Allowed Personal Number Identifier Systems 📦1.0.1 This IG
Patient.identifier:sourceSystemIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 Patient 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 Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient 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()
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'

This structure is derived from WofBasePatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
... identifier 1..* Identifier An identifier for this patient
.... use 0..0 usual | official | temp | secondary | old (If known)
.... identifier:personalNumber 1..1 Identifier National personal number for the patient
..... use 0..0 usual | official | temp | secondary | old (If known)
... name 1..1 HumanName A name associated with the patient
.... text S 1..1 string Text representation of the full name
.... family S 1..1 string Family name (often called 'Surname')
.... given S 1..1 string Given names (not always 'first'). Includes middle names
... Slices for telecom 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
.... telecom:email S 0..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
..... value S 1..1 string The actual contact point details

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... id SΣ 0..1 id Internal identifier
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId 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 Patient
.... 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 Patient
.... 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".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.text
.... identifier: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
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:personalNumber Σ 1..1 Identifier National personal number for the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: PN
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System that issued the personal number
Binding: Allowed Personal Number Identifier Systems (extensible)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Personal number value
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:sourceSystemIdentifier SΣ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name Σ 1..1 HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SΣC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... birthDate Σ 0..1 date The date of birth for the individual

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:personalNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:personalNumber.​system Base extensible Allowed Personal Number Identifier Systems 📦1.0.1 This IG
Patient.identifier:sourceSystemIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:sourceSystemIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 Patient 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 Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient 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()
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'

This structure is derived from WofBasePatient

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.telecom

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... id SΣ 0..1 id Internal identifier
... meta Σ 0..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 Patient
.... 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 Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
.... identifier:All Slices Content/Rules for all slices
.... identifier:personalNumber Σ 1..1 Identifier National personal number for the patient
..... system Σ 1..1 uri System that issued the personal number
Binding: Allowed Personal Number Identifier Systems (extensible)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Personal number value
Example General: 123456
.... identifier:sourceSystemIdentifier SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... name Σ 1..1 HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom Σ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SΣC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:personalNumber.​system Base extensible Allowed Personal Number Identifier Systems 📦1.0.1 This IG
Patient.identifier:sourceSystemIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 Patient 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 Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient 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()
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'

Differential View

This structure is derived from WofBasePatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
... identifier 1..* Identifier An identifier for this patient
.... use 0..0 usual | official | temp | secondary | old (If known)
.... identifier:personalNumber 1..1 Identifier National personal number for the patient
..... use 0..0 usual | official | temp | secondary | old (If known)
... name 1..1 HumanName A name associated with the patient
.... text S 1..1 string Text representation of the full name
.... family S 1..1 string Family name (often called 'Surname')
.... given S 1..1 string Given names (not always 'first'). Includes middle names
... Slices for telecom 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
.... telecom:email S 0..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
..... value S 1..1 string The actual contact point details

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* WofBasePatient Information about an individual or animal receiving health care services
... id SΣ 0..1 id Internal identifier
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId 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 Patient
.... 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 Patient
.... 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".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:consentToMarketing 0..1 boolean Patient consent to marketing
URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.text
.... identifier: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
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:personalNumber Σ 1..1 Identifier National personal number for the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: PN
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System that issued the personal number
Binding: Allowed Personal Number Identifier Systems (extensible)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Personal number value
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:sourceSystemIdentifier SΣ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type OΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ObligationsActorSource
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client from Wof Base Patient
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name Σ 1..1 HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:mobilePhone SΣC 1..1 ContactPoint Patient's mobile phone number, used for sms confirmation
Constraints: portal-mobile-or-empty-use
..... 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... birthDate Σ 0..1 date The date of birth for the individual

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:personalNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:personalNumber.​system Base extensible Allowed Personal Number Identifier Systems 📦1.0.1 This IG
Patient.identifier:sourceSystemIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:sourceSystemIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:mobilePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 Patient 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 Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient 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()
portal-mobile-or-empty-use error Patient.telecom:mobilePhone Mobile phone use must be 'mobile' or not set. use.empty() or use = 'mobile'

This structure is derived from WofBasePatient

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.telecom

 

Other representations of profile: CSV, Excel, Schematron