FHIR Artifacts > Structure Definition: HealthcareService Profile

Structure Definition: HealthcareService Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService

Simplifier project page: HealthcareService

Derived from: HealthcareService (R4)

Formal Views of Profile Content

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

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
textS0..1Narrative
UsageLicenseI0..1Extension(url)
MediaI0..*Extension(Attachment)
AccessInstructionsI0..1Extension(markdown)
DeliveryMethodI0..*Extension(code)
useΣ ?!0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerS Σ I0..1Reference(Organization)
activeΣ ?!1..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
categoryΣ0..*CodeableConceptBinding
PrimaryTypeI0..1Extension(boolean)
FacetS I0..*Extension(CodeableConcept)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
specialtyΣ0..*CodeableConceptBinding
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ0..1string
nameS Σ0..1string
commentS Σ0..1string
extraDetailsS0..1markdown
photoΣ I0..1Attachment
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
startS Σ I0..1dateTime
endS Σ I0..1dateTime
coverageAreaI0..*Reference(Location)
serviceProvisionCode0..*CodeableConceptBinding
codeS0..1CodeableConceptBinding
comment0..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
codingΣ0..*Coding
textΣ0..1string
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
referenceS Σ I0..1string
typeS Σ0..1uriBinding
identifierS Σ0..1Identifier
displayS Σ0..1string

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
textS0..1Narrative
UsageLicenseI0..1Extension(url)
MediaI0..*Extension(Attachment)
AccessInstructionsI0..1Extension(markdown)
DeliveryMethodI0..*Extension(code)
useΣ ?!0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerS Σ I0..1Reference(Organization)
activeΣ ?!1..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
categoryΣ0..*CodeableConceptBinding
PrimaryTypeI0..1Extension(boolean)
FacetS I0..*Extension(CodeableConcept)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
specialtyΣ0..*CodeableConceptBinding
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ0..1string
nameS Σ0..1string
commentS Σ0..1string
extraDetailsS0..1markdown
photoΣ I0..1Attachment
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
startS Σ I0..1dateTime
endS Σ I0..1dateTime
coverageAreaI0..*Reference(Location)
serviceProvisionCode0..*CodeableConceptBinding
codeS0..1CodeableConceptBinding
comment0..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
codingΣ0..*Coding
textΣ0..1string
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
referenceS Σ I0..1string
typeS Σ0..1uriBinding
identifierS Σ0..1Identifier
displayS Σ0..1string

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
textS0..1Narrative
UsageLicenseI0..1Extension(url)
MediaI0..*Extension(Attachment)
AccessInstructionsI0..1Extension(markdown)
DeliveryMethodI0..*Extension(code)
useΣ ?!0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerS Σ I0..1Reference(Organization)
activeΣ ?!1..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
categoryΣ0..*CodeableConceptBinding
PrimaryTypeI0..1Extension(boolean)
FacetS I0..*Extension(CodeableConcept)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
specialtyΣ0..*CodeableConceptBinding
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ0..1string
nameS Σ0..1string
commentS Σ0..1string
extraDetailsS0..1markdown
photoΣ I0..1Attachment
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
startS Σ I0..1dateTime
endS Σ I0..1dateTime
coverageAreaI0..*Reference(Location)
serviceProvisionCode0..*CodeableConceptBinding
codeS0..1CodeableConceptBinding
comment0..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
codingΣ0..*Coding
textΣ0..1string
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
referenceS Σ I0..1string
typeS Σ0..1uriBinding
identifierS Σ0..1Identifier
displayS Σ0..1string

Table View

HealthcareService..
HealthcareService.meta1..
HealthcareService.meta.profile1..
HealthcareService.meta.security..
HealthcareService.text..
HealthcareService.extension0..
HealthcareService.extensionExtension0..1
HealthcareService.extensionExtension0..
HealthcareService.extensionExtension0..1
HealthcareService.extensionExtension0..
HealthcareService.identifier..
HealthcareService.identifier.use..
HealthcareService.identifier.type..
HealthcareService.identifier.type.coding..
HealthcareService.identifier.type.coding.system..
HealthcareService.identifier.type.coding.code..
HealthcareService.identifier.type.coding.display..
HealthcareService.identifier.system..
HealthcareService.identifier.value..
HealthcareService.identifier.assigner..
HealthcareService.active1..
HealthcareService.providedByReference(Organization)..
HealthcareService.providedBy.display1..
HealthcareService.category..
HealthcareService.type..
HealthcareService.type.extension0..
HealthcareService.type.extensionExtension0..1
HealthcareService.type.extensionExtension0..
HealthcareService.type.coding..
HealthcareService.type.coding.system..
HealthcareService.type.coding.code..
HealthcareService.type.coding.display..
HealthcareService.locationReference(Location)..
HealthcareService.location.reference..
HealthcareService.location.display..
HealthcareService.name..
HealthcareService.comment..
HealthcareService.extraDetails..
HealthcareService.telecom..
HealthcareService.telecom.system..
HealthcareService.telecom.value..
HealthcareService.telecom.period..
HealthcareService.telecom.period.start..
HealthcareService.telecom.period.end..
HealthcareService.serviceProvisionCode..
HealthcareService.eligibility..
HealthcareService.eligibility.code..
HealthcareService.program..
HealthcareService.program.coding..
HealthcareService.program.coding.system..
HealthcareService.program.coding.code..
HealthcareService.program.coding.display..
HealthcareService.characteristic..
HealthcareService.characteristic.extension0..
HealthcareService.characteristic.extensionExtension0..
HealthcareService.characteristic.extension.value[x]..
HealthcareService.communication..
HealthcareService.endpoint..
HealthcareService.endpoint.reference..
HealthcareService.endpoint.type..
HealthcareService.endpoint.identifier..
HealthcareService.endpoint.display..


JSON View

{
    "resourceType": "StructureDefinition",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService",
    "version": "1.0.1",
    "name": "HealthcareService",
    "status": "draft",
    "description": "HealthcareService contains the details of a healthcare service available at a location.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.meta",
                "path": "HealthcareService.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "HealthcareService.meta.profile",
                "path": "HealthcareService.meta.profile",
                "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.\n\n#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService|1.0.0 `_**",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "HealthcareService.meta.security",
                "path": "HealthcareService.meta.security",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/security-labels"
                }
            },
            {
                "id": "HealthcareService.text",
                "path": "HealthcareService.text",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.extension",
                "path": "HealthcareService.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "HealthcareService.extension:UsageLicense",
                "path": "HealthcareService.extension",
                "sliceName": "UsageLicense",
                "definition": "Extension to describe the licensing conditions under which this HealthcareService (and related) resources may be used.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-usage-license"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.extension:Media",
                "path": "HealthcareService.extension",
                "sliceName": "Media",
                "definition": "Extension to capture photos, documents and files that relate to a HealthcareService.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-media"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.extension:AccessInstructions",
                "path": "HealthcareService.extension",
                "sliceName": "AccessInstructions",
                "definition": "Extension describes how a person gets started with this HealthcareService.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-access-instructions"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.extension:DeliveryMethod",
                "path": "HealthcareService.extension",
                "sliceName": "DeliveryMethod",
                "definition": "Extension to describe how the service is delivered to the client. Usually there is only one deliveryMethod, but in some case there are multiple (e.g., On “site” counseling with a “video-call” option.)",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-delivery-method"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.identifier",
                "path": "HealthcareService.identifier",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.use",
                "path": "HealthcareService.identifier.use",
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ereferral-identifier-use"
                }
            },
            {
                "id": "HealthcareService.identifier.type",
                "path": "HealthcareService.identifier.type",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ereferral-identifier-type"
                }
            },
            {
                "id": "HealthcareService.identifier.type.coding",
                "path": "HealthcareService.identifier.type.coding",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.type.coding.system",
                "path": "HealthcareService.identifier.type.coding.system",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.type.coding.code",
                "path": "HealthcareService.identifier.type.coding.code",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.type.coding.display",
                "path": "HealthcareService.identifier.type.coding.display",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.system",
                "path": "HealthcareService.identifier.system",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.value",
                "path": "HealthcareService.identifier.value",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.identifier.assigner",
                "path": "HealthcareService.identifier.assigner",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.active",
                "path": "HealthcareService.active",
                "min": 1
            },
            {
                "id": "HealthcareService.providedBy",
                "path": "HealthcareService.providedBy",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "HealthcareService.providedBy.display",
                "path": "HealthcareService.providedBy.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "HealthcareService.category",
                "path": "HealthcareService.category",
                "comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.\nThe high level healthcare sector of the listing. (e.g.,  Mental health service, Community health services, Laboratory service, etc)",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/healthcareservice-categories"
                }
            },
            {
                "id": "HealthcareService.type",
                "path": "HealthcareService.type",
                "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\n\n<a href=\"https://tgateway.infoway-inforoute.ca/singlesubset.html?id=2.16.840.1.113883.3.239.12.38&versionid=20220429\">LINK TO VALUE SET</a>",
                "mustSupport": true,
                "binding": {
                    "strength": "preferred",
                    "description": "Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty"
                }
            },
            {
                "id": "HealthcareService.type.extension",
                "path": "HealthcareService.type.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "HealthcareService.type.extension:PrimaryType",
                "path": "HealthcareService.type.extension",
                "sliceName": "PrimaryType",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-primary-type"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.type.extension:Facet",
                "path": "HealthcareService.type.extension",
                "sliceName": "Facet",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-facet"
                        ]
                    }
                ],
                "mustSupport": true,
                "isModifier": false
            },
            {
                "id": "HealthcareService.type.coding",
                "path": "HealthcareService.type.coding",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.type.coding.system",
                "path": "HealthcareService.type.coding.system",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.type.coding.code",
                "path": "HealthcareService.type.coding.code",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.type.coding.display",
                "path": "HealthcareService.type.coding.display",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.location",
                "path": "HealthcareService.location",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "HealthcareService.location.reference",
                "path": "HealthcareService.location.reference",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.location.display",
                "path": "HealthcareService.location.display",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.name",
                "path": "HealthcareService.name",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.comment",
                "path": "HealthcareService.comment",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.extraDetails",
                "path": "HealthcareService.extraDetails",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.telecom",
                "path": "HealthcareService.telecom",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.telecom.system",
                "path": "HealthcareService.telecom.system",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.telecom.value",
                "path": "HealthcareService.telecom.value",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.telecom.period.start",
                "path": "HealthcareService.telecom.period.start",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.telecom.period.end",
                "path": "HealthcareService.telecom.period.end",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.serviceProvisionCode",
                "path": "HealthcareService.serviceProvisionCode",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/service-provision-conditions"
                }
            },
            {
                "id": "HealthcareService.eligibility.code",
                "path": "HealthcareService.eligibility.code",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/eligibility-criteria"
                }
            },
            {
                "id": "HealthcareService.program.coding.system",
                "path": "HealthcareService.program.coding.system",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.program.coding.code",
                "path": "HealthcareService.program.coding.code",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.program.coding.display",
                "path": "HealthcareService.program.coding.display",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.characteristic.extension",
                "path": "HealthcareService.characteristic.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "HealthcareService.characteristic.extension:Facet",
                "path": "HealthcareService.characteristic.extension",
                "sliceName": "Facet",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ext-facet"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "HealthcareService.characteristic.extension:Facet.value[x]",
                "path": "HealthcareService.characteristic.extension.value[x]",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.communication",
                "path": "HealthcareService.communication",
                "binding": {
                    "strength": "preferred",
                    "description": "Languages understood or supported by Ontario clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020.",
                    "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language"
                }
            },
            {
                "id": "HealthcareService.endpoint",
                "path": "HealthcareService.endpoint",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.endpoint.reference",
                "path": "HealthcareService.endpoint.reference",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.endpoint.type",
                "path": "HealthcareService.endpoint.type",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.endpoint.identifier",
                "path": "HealthcareService.endpoint.identifier",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.endpoint.display",
                "path": "HealthcareService.endpoint.display",
                "mustSupport": true
            }
        ]
    }
}

Usage

The HealthcareService resource is used to describe a healthcare service provided by an organization at a location.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService|1.0.0

.meta.security

  • used to identify if the HealthcareService resource is the master record, copy of a master record, or a draft record in a federated network of HealthcareService directories
  • SHOULD be populated with one of the following codes:
    • MASTERMark - It is the Master Record managed by a Master Record Holder (MRH), for use in a federated network of HealthcareService directories.
    • COPYMark - if it is a copy of a Master Record in a federated system
    • DRAFTMark - if the HealthcareService is still under development
    • NOREUSE - Marks the prohibition on the use of the information beyond the use initially authorized (which can be found in the usage-licence extension)

.text

  • SHOULD display an HTML summary of the resource. Treat it as content which could be displayed when reviewing the service in a viewer (like a website or EMR)

.text.status

  • SHOULD be set to generated in most cases, as it is a computer generated summary computer assembled from the HealthcareService elements. See Narrative Status ValueSet

.text.div

  • Holds the basic HTML version of the HealthcareService summarized

  • General recommended format is bold label, colon separator and value - but this is not a hard rule. E.g.

    Name: Northern Senior’s Services

    Provided by: True North Health Clinic

    Type: Meals on Wheels, Transportation

.extension:usage-license

  • Describes the licensing conditions under which this HealthcareService (and related resources) may be used

.extension:media

  • Photos, documents and files that relate to a HealthcareService

  • File size and type constraints to be determined by implementation partners

  • Restricted to “safe” data types

    • Images: jpeg, jpg, png, gif, ico

    • Documents: pdf

    • Video: youtube or vimeo links

    Note: Use the “.url” not “.data” field, to prevent search API filesizes from being too large.

.extension:AccessInstructions

  • Describes the process for how to get started with this HealthcareService
  • Use markdown because this often contains links to external sites

.extension:delivery-method

  • Describes how the service is delivered to the client, usually there is only one deliveryMethod, but in some cases there are multiple (e.g., On “site” counseling with a “video-call” option.)
  • For example, home visit, telephone encounters, in person, etc.

.identifier

  • Business identifier(s) that are specific to this HealthcareService
  • Identifiers corresponding to clinician qualifications (such as CPSO number) SHOULD be included in the Practitioner resource not HealthcareService
  • HealthcareService identifiers can be applied in a generic way, with no special constraints
  • MAY contain multiple identifiers such as directory identifiers (e.g., 211), industry issued identifiers (e.g., pharmacy IDs), local system identifiers, and master identifiers in a federated data sharing model.
  • For additional information and implementation guidance on Identifiers, please see the Identifiers section under HealthcareService Directories on the Business Rules page of this implementation guide

identifier.use

  • SHOULD contain a code of official for master record identifier and any official externally granted identifiers (e.g., pharmacy ID).
  • SHOULD contain a code of secondary for local identifiers and other identifiers which are not the master recorded (in a federated data sharing model), not issued by a master record holder.

identifier.type

  • When populated, SHALL contain a code of HCS representing HealthcareService

identifier.system

  • The namespace for the identifier value (i.e., the “source identifier issuer system”), where the value must be unique within the system.
  • Different HealthcareService directories MAY apply their own system to share their local identifier for the HealthcareService, e.g., www.hcs-directory-app.com/fhir/sid/listing-id

identifier.value

  • SHOULD contain a unique value for the identifier within its system
  • Master Record identifiers (generated by a Master Record Holder, MRH) SHALL use UUIDs or some other globally unique naming convention.

identifier.assigner

  • MAY contain a reference to the organization issuing the identifier
  • MAY contain only a string of text

active

  • SHALL be populated with true if the service is available and active
  • SHALL be populated with false if the service has been deactivated
  • NOTE: HealthcareServices should only become “.active=false”, never deleted, this will ensure that historical actions related to the service can maintain their referential integrity.
  • The concept of temporarily “Suspended” services can be handled via the corresponding Location.status=active.

providedBy

  • The Organization providing the services, if multiple agencies are providing the service, select the single organization that is the primary lead of the service
  • SHOULD be populated with a reference to the Organization where the services are being offered
  • NOTE: referrals must be made to a HealthcareService which has an organization, never directly to the organization.

providedBy.reference

  • SHOULD contain a literal reference, relative, internal or absolute URL

providedBy.identifier

  • MAY include any identifiers associated with the referenced Organization resource

providedBy.type

  • SHOULD be populated with Organization

providedBy.display

  • SHALL be populated with a string of the organization name. e.g., “Canadian Red Cross - Barrie Branch”

category

  • The highlevel healthcare sector of the listing
  • SHOULD be populated with a code from the value set representing the healthcare sector of the listing
  • SHALL NOT be used for taxonomy classification, use .type for taxonomy

type

  • SHALL be used to classify HealthcareService directories into taxonomies
  • supports single tag based, multi-tag, multi-tag with a primary tag, hierarchical, faceted or a combination of these taxonomy approaches
  • For additional information and implementation guidance on the Taxonomies supported in the .type element, please refer to the Taxonomy section on the Business Rules page of this implementation guide

type.extension:PrimaryType

  • SHOULD be used for multi-tag taxonomies where the primary tag needs to be identified

type.extension:Facet

  • SHOULD be used in a faceted taxonomy to represent each facet category

specialty

  • SHALL NOT be used to express specialties handled by the service site, use .type for speciality and sub-specialty, please refer to the Taxonomy section for more information

location

  • identifies the Location(s) where the services may be provided
  • SHOULD be populated with a reference to the Location where the services are being provided
  • For additional information and implementation guidance on the use of .location, please see the Location section on the Business Rules page of this implementation guide

location.reference

  • MAY contain a literal reference, relative, internal or absolute URL

location.type

  • SHOULD be populated with Location

location.identifer

  • MAY contain identifiers associated with the referenced Location resource

location.display

  • MAY contain the full address(es) of the service
  • Address(es) SHOULD be resolvable by geo-code APIs such as Google Maps (e.g., 10 Main st, Toronto, Ontario, Canada)

name

  • SHOULD contain the name of the healthcareService presented to the consumer & referrer, e.g., "Lakeshore Adult Day Program"

comment

  • SHOULD include the PRIMARY summary description details about a service. This would be presented to users as the quick summary information about a service in search. Its content should be kept short.

extraDetails

  • SHOULD include the SECONDARY description details about a service (which may be omitted from a service summary, or accessible through "view more" options)
  • MAY hold data from specialized fields that are part of a specialized directory, but are not part of this specification. These extra fields can be formatted visually with Markdown to simulate how the might commonly be displayed as proper data fields. E.g., Accessibility: Wheelchair accessible.
    However, the handling of these additional fields is better served with the “.characteristics” field.

photo

  • MAY contain a hero image of the service to visually facilitate quick identification of the services
  • MAY be shown as a thumbnail in search results, or as a hero photo in service listings page.
  • Use photo.url rather than photo.data, to keep payloads small.

telecom

  • The inquiry phone, email, fax and informational web page for this service
  • For URLs, SHOULD contain only a single URL unless referencing additional social media related URLs
  • SHOULD contain telecom related information for the purpose of Access information (e.g. when a person calls to ask for information related to the offered services)
  • For additional information and implementation guidance on the use of .telecom, please see the Telecom section on the Business Rules page of this implementation guide

telecom.system

  • SHOULD contain a code representing the telecom type (e.g. phone for phone number, url for website, etc.)
  • Pager, url, sms and other have limited practical use for HelathcareService directories
  • There SHALL be only be ONE url telecom, unless the additional urls reference common social urls in their path (i.e., facebook, linkedIn, instagram, tiktok).

telecom.value

  • SHOULD contain the contact point details (e.g. string containing telephone number)

telecom.use

  • When populated, SHALL always contain work for HealthcareService

telecom.rank

  • When more than one ContactPoint of the same system, SHOULD be ordered by priority rank

telecom.period

  • MAY contain the time period when the ContactPoint was/is in use

coverageArea

  • A coverageArea can be thought of as an “eligibility area”. It is more relevant to some delivery methods (e.g. home visits) than others.
  • A coverage area is represented by GeoJSON shapefiles, which can be a single shape or a multi-shape (see www.geojson.io)
  • The GeoJSON shapefile is included in the referenced Location resource using the boundary-geojson extension (via HealthcareSerivce.coverageArea > Location.extension.location-boundary-geojson.url). Shapefiles can be large, so reference them using the extension’s url field for asynchronous retrieval, rather than including them in payloads.
  • There are special rules for the use of coverageArea in conjunction with the deliveryMethod extension
    • “home”, “phone”, “video” SHOULD have a coverageArea
    • Remaining deliveryMethods MAY have a coverageArea

coverageArea.reference

  • SHOULD be populated with a reference to the Location resource

coverageArea.type

  • SHOULD be populated with Location

coverageArea.identifier

  • MAY contain identifiers associated with the referenced Location resource
  • This field is not expected to have significant use for HealthcareService directories.

coverageArea.display

  • SHOULD contain the descriptive name of the coverageArea shape (e.g. City of Thunder Bay, Town of Orangeville)

serviceProvisionCode

  • SHOULD be populated with free for no charge services or those covered under provincial insurance
  • SHOULD be populated with fees-apply for services that are not free and not covered under provincial insurance
  • e.g.
    coding.code=free
    coding.display=Free
    .text = Free (may add additional narrative colour here, such as “Covered by OHIP”

eligibility

  • Eligibility SHOULD be expressed in way that can be agreed to with a “yes/no”, "met/unmet" statement (e.g. Is the registrant over the age of 18?) so that applications can clearly ask users if they meet the eligibility criteria (yes/no) before proceeding to a referral step (e.g. The registrant is a resident of Toronto)
  • Avoid putting multiple eligibility criteria into a single data row, instead express each criteria as its own entry.
  • Express free text with yes/no, yes=pass questions using ‘.eligibility.comment’ (e.g. is a resident of Toronto)

eligibility.code

  • For uncoded eligibility statements, use only the eligibility.code.text field
  • Eligibility coding (e.g., “non-smoker) can help with search/match functions. If coding is available, then also use eligibility.code.coding

program

  • Used to group services provided by one or many organizations under a formal “program” label program, e.g. Ontario eConsult, Eastern Immunization Program, Canada Craving Change
  • Since the creation (and dissolution) of programs is very dynamic, it is unlikely that a central coding system will be available for this, so be sure to use at least the .text element in the CodeableConcept for human readability. Using coding will be necessary to enable filtered search by program.
  • For additional information and implementation guidance on the use of .program, please see the Program section on the Business Rules page of this implementation guide

program.text

  • SHOULD contain a human readable string containing the program name

characteristic

  • MAY contain additional “tags” or “keywords” that a specialized HealthcareService directory may have, but do not apply to the other fields within this resource
  • Faceted tags SHOULD be applied using the Facet extension on .characteristic
  • For additional information and implementation guidance on the use of .characteristic, please see the Characteristic section on the Business Rules page of this implementation guide

characteristic.coding

  • MAY contain the codes related to a local coding system
  • Basic tags using a flat tagging structure SHOULD be applied here

characteristic.text

  • MAY contain the “tag” or "keyword" used to communicate additional data fields related to a HealthcareService

communication

  • SHOULD contain the language this HealthcareService is offered in

appointmentRequired

  • Indicates that a referral will only be accepted in conjunction with an appointment booking

availableTime

  • Used to represent the Access Hours (i.e. when someone can call to get started or ask for information) and not Operational Hours
  • For additional information and implementation guidance on the use of .availableTime, please see the Available Time section on the Business Rules page of this implementation guide

availableTime.daysOfWeek

  • MAY contain a code representing the day(s) of the week the service is accessible, one or more of mon | tue | wed | thu | fri | sat | sun

.availableTime.allDay

  • SHOULD be set to true for 24 hour service

availableTime.availableStartTime

  • MAY contain opening time of day (ignore if .allDay = true)

availableTime.availableEndTime

  • MAY contain closing time fo day (ignore if .allDay = true)

notAvailable

  • Not available during this time due to the provided reason (in .description).

  • The notAvailable time is computable so long as “during” is included. If “during” is omitted then the “description” is a simple text description of when not available (e.g., Christmas, new years)

notAvailable.description

  • SHOULD contain a text description reason presented to the user about why the time is not available (e.g. New Years)

notAvailable.during

  • SHOULD contain a date range of when services are not available

endpoint

  • SHOULD contain technical endpoints providing access to services operated for the location including:
    • Retrieving the master record for this HealthcareService
    • Submitting a ServiceRequest
    • Referral webpage URLs
    • SMART on FHIR URLs
    • Referral Questionnaires
  • For additional information and implementation guidance on the use of .endpoint, please see the Endpoint section on the Business Rules page of this implementation guide

endpoint.type

  • SHOULD be populated with Endpoint

endpoint.display

  • MAY display the endpoint name

Search Parameters

Name Parameter Description Sample Expression
identifier HealthcareService.identifier Identifier codes for the service. GET [BASE]/HealthcareService?identifier=6687452