AddCommunication Implementation Guide
2.2 - version 2.2

This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: HealthCareService

Official URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/CommunicationHealthCareService Version: 2.2
Draft as of 2025-02-04 Computable Name: CommunicationHealthCareService

Profile to hold information about the HealthCareService that requests the communication.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri HSAID
ele-1: All FHIR elements must have a @value or children
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value ΣC 1..1 string HSA-ID of the HealthCareService
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
ele-1: All FHIR elements must have a @value or children
... location Σ 0..1 Reference(Location) Address of the HealthCareService
ele-1: All FHIR elements must have a @value or children
... name Σ 0..1 string Name of the HealthCareService
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... identifier 0..1 Identifier Identifer of the HealthCareService
.... system 0..1 uri HSAID
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value 1..1 string HSA-ID of the HealthCareService
... location 0..1 Reference(Location) Address of the HealthCareService
... name 0..1 string Name of the HealthCareService
.... telecom
..... system 0..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 0..1 string Telephone number of the HealthCareService

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifer of the HealthCareService
.... id 0..1 id 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 Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 0..1 uri HSAID
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value ΣC 1..1 string HSA-ID of the HealthCareService
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)
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ 0..1 Reference(Location) Address of the HealthCareService
... name Σ 0..1 string Name of the HealthCareService
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.

.... name Σ 0..* HumanName Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 0..1 string Telephone number of the HealthCareService
..... 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
.... address Σ 0..1 Address Address for the contact
.... organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
.... period Σ 0..1 Period Period that this contact was valid for usage
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... 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
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available.

.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).


... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.


... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
HealthcareService.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
HealthcareService.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
HealthcareService.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
HealthcareService.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexampleServiceMode
http://hl7.org/fhir/ValueSet/service-mode
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())

This structure is derived from HealthcareService

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri HSAID
ele-1: All FHIR elements must have a @value or children
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value ΣC 1..1 string HSA-ID of the HealthCareService
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
ele-1: All FHIR elements must have a @value or children
... location Σ 0..1 Reference(Location) Address of the HealthCareService
ele-1: All FHIR elements must have a @value or children
... name Σ 0..1 string Name of the HealthCareService
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... identifier 0..1 Identifier Identifer of the HealthCareService
.... system 0..1 uri HSAID
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value 1..1 string HSA-ID of the HealthCareService
... location 0..1 Reference(Location) Address of the HealthCareService
... name 0..1 string Name of the HealthCareService
.... telecom
..... system 0..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 0..1 string Telephone number of the HealthCareService

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
must-have-hasaid-or-location-telecom: If there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
... 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Identifer of the HealthCareService
.... id 0..1 id 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 Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 0..1 uri HSAID
Required Pattern: urn:oid:1.2.752.129.2.1.4.1
.... value ΣC 1..1 string HSA-ID of the HealthCareService
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)
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ 0..1 Reference(Location) Address of the HealthCareService
... name Σ 0..1 string Name of the HealthCareService
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.

.... name Σ 0..* HumanName Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 0..1 string Telephone number of the HealthCareService
..... 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
.... address Σ 0..1 Address Address for the contact
.... organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
.... period Σ 0..1 Period Period that this contact was valid for usage
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... 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
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available.

.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).


... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.


... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
HealthcareService.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
HealthcareService.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
HealthcareService.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
HealthcareService.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexampleServiceMode
http://hl7.org/fhir/ValueSet/service-mode
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
must-have-hasaid-or-location-telecomerrorHealthcareServiceIf there is no HealthCareService identifier (HSA-id), there must be an location with address and telephone number.
: identifier.exists() or (location.exists() and contact.telecom.exists())

This structure is derived from HealthcareService

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron