ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-patient | Version: 1.0.0 | |||
| Active as of 2026-04-20 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |||||||
![]() ![]() |
SΣ | 0..1 | id | Internal identifier | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |||||||
![]() ![]() |
Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | National personal number for the patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Personal number value Example General: 123456 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use | ||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:personalNumber.system | Base | extensible | Allowed Personal Number Identifier Systems | 📦1.0.0 | This IG |
| Patient.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | id | Server-managed resource version | |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profile declaration for this portal resource | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |
![]() ![]() |
1..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | Identifier | National personal number for the patient | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
SC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
Documentation for this format | ||||
| 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'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |||||||
![]() ![]() |
SΣ | 0..1 | id | Internal identifier | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
![]() ![]() ![]() |
Σ | 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". | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |||||||
![]() ![]() |
Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | National personal number for the patient | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PN | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Personal number value Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||||
Documentation for this format | ||||||||||
| 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.0 | 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.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. |
| 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: 0 element(4 nested mandatory elements)
Must-Support: 4 elements
Fixed: 2 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |||||||
![]() ![]() |
SΣ | 0..1 | id | Internal identifier | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |||||||
![]() ![]() |
Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | National personal number for the patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Personal number value Example General: 123456 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use | ||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:personalNumber.system | Base | extensible | Allowed Personal Number Identifier Systems | 📦1.0.0 | This IG |
| Patient.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | id | Server-managed resource version | |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profile declaration for this portal resource | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |
![]() ![]() |
1..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | Identifier | National personal number for the patient | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
SC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBasePatient | Information about an individual or animal receiving health care services | |||||||
![]() ![]() |
SΣ | 0..1 | id | Internal identifier | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
![]() ![]() ![]() |
Σ | 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". | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
0..1 | boolean | Portal Consent To Marketing URL: http://portal.wof.purified.link/fhir/StructureDefinition/extConsentToMarketing | |||||||
![]() ![]() |
Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | National personal number for the patient | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PN | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Personal number value Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
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.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | ContactPoint | A contact detail for the individual Constraints: portal-mobile-or-empty-use | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||||
Documentation for this format | ||||||||||
| 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.0 | 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.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. |
| 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: 0 element(4 nested mandatory elements)
Must-Support: 4 elements
Fixed: 2 elements
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron