Visit the HL7 website
Visit the FHIR website

Pan-Canadian Care Service Directory (1.0.0-DFT)

1.0.0-DFT   Canada flag
  • Table-of-Contents
  • Home
  • Business Context
    • Guidance
    • Usage Highlights
    • Use Cases
    • Guide Considerations
  • Technical Context
    • Overview
    • Background
    • Roles Description
    • Model Diagrams
    • Queries
    • Bulk Export
  • FHIR Artifacts
    • Endpoint
    • Extension DeliveryMethod
    • Extension UsageLicense
    • FacilityLocation
    • FacilityOrganization
    • HealthcareService
    • JurisdictionLocation
    • JurisdictionOrganization
    • Location
    • LocationDistance
    • Organization
    • OrganizationAffiliation
    • Practitioner
    • PractitionerRole
    • Capability Statements
    • Operations
    • Example - Queries
    • Example - Resources
  • Change Log
    1. Table-of-Contents
    2. FHIR Artifacts
    3. HealthcareService

DFT - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

HealthcareService

Links

Profile

CA-CSD-HealthcareService

Derived from

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService

Examples

ca-csd-example-healthcare-service

Description

A HealthcareService will have a unique identifier. Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services. Additional attributes such as location of service, contract person, hours of operation etc. can be included.

References to this resource

OrganizationAffiliation, PractitionerRole

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
HealthcareServiceIMCSDHealthcareService
There are no (further) constraints on this element
Element id

HealthcareService

Short description

The details of a healthcare service available at a location

Definition

The details of a healthcare service available at a location.

Data type

MCSDHealthcareService

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • 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
    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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: act[classCode=ACT][moodCode=DEF]
idΣ0..1id
There are no (further) constraints on this element
Element id

HealthcareService.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

metaΣ0..1Meta
There are no (further) constraints on this element
Element id

HealthcareService.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
id0..1string
There are no (further) constraints on this element
Element id

HealthcareService.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
versionIdΣ0..1id
There are no (further) constraints on this element
Element id

HealthcareService.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
lastUpdatedS Σ0..1instantElement id

HealthcareService.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

Identified as a query requirement through mCSD CapabilityStatement.

Data type

instant

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
sourceΣ0..1uri
There are no (further) constraints on this element
Element id

HealthcareService.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
profileΣ0..*canonical(StructureDefinition)
There are no (further) constraints on this element
Element id

HealthcareService.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

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.

Data type

canonical(StructureDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id

HealthcareService.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
tagΣ0..*Coding
There are no (further) constraints on this element
Element id

HealthcareService.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..0uri
There are no (further) constraints on this element
Element id

HealthcareService.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id

HealthcareService.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id

HealthcareService.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id

HealthcareService.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionI0..*ExtensionElement id

HealthcareService.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
deliveryMethodI0..*Extension(code)Element id

HealthcareService.extension:deliveryMethod

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension(code)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
usageLicenseI0..*Extension(url)Element id

HealthcareService.extension:usageLicense

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension(url)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
modifierExtension?! I0..0Extension
There are no (further) constraints on this element
Element id

HealthcareService.modifierExtension

Short description

Extension

Definition

An Extension

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
identifierS Σ1..*IdentifierElement id

HealthcareService.identifier

Short description

External identifiers for this item

Definition

External identifiers for this item.

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
activeS Σ ?!1..1booleanElement id

HealthcareService.active

Short description

Whether this HealthcareService record is in active use

Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Comments

Identified as a query requirement through mCSD CapabilityStatement.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
providedByS Σ0..1Reference(Organization)Element id

HealthcareService.providedBy

Short description

The organization providing this service.

Definition

The organization providing this service.

Comments

This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scopingRole.Organization
categoryS Σ0..*CodeableConceptElement id

HealthcareService.category

Short description

Broad category of service being performed or delivered

Alternate names

service category

Definition

Identifies the broad category of service being performed or delivered.

Comments

Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information.

Data type

CodeableConcept

Binding

A category of the service(s) that could be provided.

ServiceCategory (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .code
typeS Σ1..*CodeableConceptElement id

HealthcareService.type

Short description

The type of service being provided.

Alternate names

service type

Definition

The type of service being provided.

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking.

Data type

CodeableConcept

Binding

Additional details about where the content was created (e.g. clinical specialty).

ServiceType (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
specialtyΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id

HealthcareService.specialty

Short description

Specialties handled by the HealthcareService

Definition

Collection of specialties handled by the service site. This is more of a medical term.

Data type

CodeableConcept

Binding

A specialty that a healthcare service may provide.

PracticeSettingCodeValueSet (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
locationS Σ0..*Reference(Location)Element id

HealthcareService.location

Short description

The location where the service is being provided.

Definition

The location where the service is being provided.

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Location)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.where[x]
  • rim: .location.role[classCode=SDLOC]
nameS Σ1..1stringElement id

HealthcareService.name

Short description

The name of the service being provided.

Definition

The name of the service being provided.

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
commentΣ0..1string
There are no (further) constraints on this element
Element id

HealthcareService.comment

Short description

Additional description and/or any specific issues not covered elsewhere

Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .location.role[classCode=SDLOC].desc
extraDetails0..1markdown
There are no (further) constraints on this element
Element id

HealthcareService.extraDetails

Short description

Extra details about the service that can't be placed in the other fields

Definition

Extra details about the service that can't be placed in the other fields.

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text
photoΣ0..1Attachment
There are no (further) constraints on this element
Element id

HealthcareService.photo

Short description

Facilitates quick identification of the service

Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

Data type

Attachment

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=SBJ].observation.value
telecom0..*ContactPoint
There are no (further) constraints on this element
Element id

HealthcareService.telecom

Short description

Contacts related to the healthcare service

Definition

List of contacts related to this specific healthcare service.

Comments

If this is empty, then refer to the location's contacts.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
coverageArea0..*Reference(Location)
There are no (further) constraints on this element
Element id

HealthcareService.coverageArea

Short description

Location(s) service is intended for/available to

Definition

The location(s) that this service is available to (not where the service is provided).

Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Data type

Reference(Location)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate
serviceProvisionCode0..*CodeableConcept
There are no (further) constraints on this element
Element id

HealthcareService.serviceProvisionCode

Short description

Conditions under which service is available/offered

Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Data type

CodeableConcept

Binding

The code(s) that detail the conditions under which the healthcare service is available/offered.

ServiceProvisionConditions (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
eligibility0..*BackboneElement
There are no (further) constraints on this element
Element id

HealthcareService.eligibility

Short description

Specific eligibility requirements required to use the service

Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
id0..1string
There are no (further) constraints on this element
Element id

HealthcareService.eligibility.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.eligibility.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.eligibility.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
code0..1CodeableConcept
There are no (further) constraints on this element
Element id

HealthcareService.eligibility.code

Short description

Coded value for the eligibility

Definition

Coded value for the eligibility.

Data type

CodeableConcept

Binding

Coded values underwhich a specific service is made available.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
comment0..1markdown
There are no (further) constraints on this element
Element id

HealthcareService.eligibility.comment

Short description

Describes the eligibility conditions for the service

Definition

Describes the eligibility conditions for the service.

Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text
program0..*CodeableConcept
There are no (further) constraints on this element
Element id

HealthcareService.program

Short description

Programs that this service is applicable to

Definition

Programs that this service is applicable to.

Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

Data type

CodeableConcept

Binding

Government or local programs that this service applies to.

Program (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
characteristic0..*CodeableConcept
There are no (further) constraints on this element
Element id

HealthcareService.characteristic

Short description

Collection of characteristics (attributes)

Definition

Collection of characteristics (attributes).

Comments

These could be such things as is wheelchair accessible.

Data type

CodeableConcept

Binding

A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
communication0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id

HealthcareService.communication

Short description

The language that this service is offered in

Definition

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

Data type

CodeableConcept

Binding

A human language.

CommonLanguages (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
referralMethod0..*CodeableConcept
There are no (further) constraints on this element
Element id

HealthcareService.referralMethod

Short description

Ways that the service accepts referrals

Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Data type

CodeableConcept

Binding

The methods of referral can be used when referring to a specific HealthCareService resource.

ReferralMethod (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
appointmentRequired0..1boolean
There are no (further) constraints on this element
Element id

HealthcareService.appointmentRequired

Short description

If an appointment is required for access to this service

Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
availableTime0..*BackboneElement
There are no (further) constraints on this element
Element id

HealthcareService.availableTime

Short description

Times the Service Site is available

Definition

A collection of times that the Service Site is available.

Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
id0..1string
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
daysOfWeek0..*codeBinding
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.daysOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

Indicates which days of the week are available between the start and end Times.

Data type

code

Binding

The days of the week.

DaysOfWeek (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
allDay0..1boolean
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.allDay

Short description

Always available? e.g. 24 hour service

Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availableStartTime0..1time
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.availableStartTime

Short description

Opening time of day (ignored if allDay = true)

Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The time zone is expected to be for where this HealthcareService is provided at.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availableEndTime0..1time
There are no (further) constraints on this element
Element id

HealthcareService.availableTime.availableEndTime

Short description

Closing time of day (ignored if allDay = true)

Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The time zone is expected to be for where this HealthcareService is provided at.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
notAvailable0..*BackboneElement
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable

Short description

Not available during this time due to provided reason

Definition

The HealthcareService is not available during this period of time due to the provided reason.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
id0..1string
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
description1..1string
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable.description

Short description

Reason presented to the user explaining why time not available

Definition

The reason that can be presented to the user as to why this time is not available.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
during0..1Period
There are no (further) constraints on this element
Element id

HealthcareService.notAvailable.during

Short description

Service not available from this date

Definition

Service is not available (seasonally or for a public holiday) from this date.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availabilityExceptions0..1string
There are no (further) constraints on this element
Element id

HealthcareService.availabilityExceptions

Short description

Description of availability exceptions

Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
endpoint0..*Reference(Endpoint)
There are no (further) constraints on this element
Element id

HealthcareService.endpoint

Short description

Technical endpoints providing access to electronic services operated for the healthcare service

Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Data type

Reference(Endpoint)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareServiceMCSDHealthcareService
There are no (further) constraints on this element
Data type

MCSDHealthcareService

meta
There are no (further) constraints on this element
lastUpdatedS
There are no (further) constraints on this element
Element id

HealthcareService.meta.lastUpdated

Comments

Identified as a query requirement through mCSD CapabilityStatement.

deliveryMethodExtension(code)
There are no (further) constraints on this element
Element id

HealthcareService.extension:deliveryMethod

Data type

Extension(code)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method

usageLicenseExtension(url)
There are no (further) constraints on this element
Element id

HealthcareService.extension:usageLicense

Data type

Extension(url)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license

identifierS1..
There are no (further) constraints on this element
Element id

HealthcareService.identifier

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile.

activeS1..
There are no (further) constraints on this element
Element id

HealthcareService.active

Comments

Identified as a query requirement through mCSD CapabilityStatement.

providedBySReference(Organization)
There are no (further) constraints on this element
Element id

HealthcareService.providedBy

Comments

This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource.

Data type

Reference(Organization)

categoryS
There are no (further) constraints on this element
Element id

HealthcareService.category

Comments

Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information.

typeS
There are no (further) constraints on this element
Element id

HealthcareService.type

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking.

locationSReference(Location)
There are no (further) constraints on this element
Element id

HealthcareService.location

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Location)

nameS
There are no (further) constraints on this element
Element id

HealthcareService.name

Comments

Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-CSD-HealthcareService" />
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:able-to-populate" />
        </extension>
        <extension url="code">
            <valueCode value="SHOULD:populate" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.active" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.providedBy" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.type" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.location" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.name" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
        </extension>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:no-error" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.active" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.providedBy" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.type" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.location" />
        </extension>
        <extension url="elementId">
            <valueString value="HealthcareService.name" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" />
        </extension>
    </extension>
    <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService" />
    <name value="HealthcareService" />
    <status value="draft" />
    <description value="A HealthcareService will have a unique identifier.  Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services.  Additional attributes such as location of service, contract person, hours of operation etc. can be included." />
    <copyright value="Copyright &#169; 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="HealthcareService" />
    <baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService" />
    <derivation value="constraint" />
    <differential>
        <element id="HealthcareService.meta.lastUpdated">
            <path value="HealthcareService.meta.lastUpdated" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.extension:deliveryMethod">
            <path value="HealthcareService.extension" />
            <sliceName value="deliveryMethod" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method" />
            </type>
        </element>
        <element id="HealthcareService.extension:usageLicense">
            <path value="HealthcareService.extension" />
            <sliceName value="usageLicense" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license" />
            </type>
        </element>
        <element id="HealthcareService.identifier">
            <path value="HealthcareService.identifier" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.active">
            <path value="HealthcareService.active" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.providedBy">
            <path value="HealthcareService.providedBy" />
            <comment value="This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.category">
            <path value="HealthcareService.category" />
            <comment value="Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information." />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.type">
            <path value="HealthcareService.type" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking." />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.location">
            <path value="HealthcareService.location" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.name">
            <path value="HealthcareService.name" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "CA-CSD-HealthcareService",
    "extension":  [
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:able-to-populate"
                },
                {
                    "url": "code",
                    "valueCode": "SHOULD:populate"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.active"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.providedBy"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.type"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.location"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.name"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        },
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:no-error"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.active"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.providedBy"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.type"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.location"
                },
                {
                    "url": "elementId",
                    "valueString": "HealthcareService.name"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client"
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        }
    ],
    "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService",
    "name": "HealthcareService",
    "status": "draft",
    "description": "A HealthcareService will have a unique identifier.  Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services.  Additional attributes such as location of service, contract person, hours of operation etc. can be included.",
    "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.meta.lastUpdated",
                "path": "HealthcareService.meta.lastUpdated",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.extension:deliveryMethod",
                "path": "HealthcareService.extension",
                "sliceName": "deliveryMethod",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.extension:usageLicense",
                "path": "HealthcareService.extension",
                "sliceName": "usageLicense",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.identifier",
                "path": "HealthcareService.identifier",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "HealthcareService.active",
                "path": "HealthcareService.active",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "HealthcareService.providedBy",
                "path": "HealthcareService.providedBy",
                "comment": "This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "HealthcareService.category",
                "path": "HealthcareService.category",
                "comment": "Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information.",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.type",
                "path": "HealthcareService.type",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking.",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.location",
                "path": "HealthcareService.location",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "HealthcareService.name",
                "path": "HealthcareService.name",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
                "mustSupport": true
            }
        ]
    }
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
HealthcareService.meta.securityextensiblehttp://hl7.org/fhir/ValueSet/security-labels
HealthcareService.meta.tagexamplehttp://hl7.org/fhir/ValueSet/common-tags
HealthcareService.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
HealthcareService.categoryexamplehttp://hl7.org/fhir/ValueSet/service-category
HealthcareService.typeexamplehttp://hl7.org/fhir/ValueSet/service-type
HealthcareService.specialtypreferredhttp://hl7.org/fhir/ValueSet/c80-practice-codes
HealthcareService.serviceProvisionCodeexamplehttp://hl7.org/fhir/ValueSet/service-provision-conditions
HealthcareService.programexamplehttp://hl7.org/fhir/ValueSet/program
HealthcareService.communicationpreferredhttp://hl7.org/fhir/ValueSet/languages
HealthcareService.referralMethodexamplehttp://hl7.org/fhir/ValueSet/service-referral-method
HealthcareService.availableTime.daysOfWeekrequiredhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1
PathConformanceValueSet
HealthcareService.meta.securityextensiblehttp://hl7.org/fhir/ValueSet/security-labels
HealthcareService.meta.tagexamplehttp://hl7.org/fhir/ValueSet/common-tags
HealthcareService.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
HealthcareService.categoryexamplehttp://hl7.org/fhir/ValueSet/service-category
HealthcareService.typeexamplehttp://hl7.org/fhir/ValueSet/service-type
HealthcareService.specialtypreferredhttp://hl7.org/fhir/ValueSet/c80-practice-codes
HealthcareService.serviceProvisionCodeexamplehttp://hl7.org/fhir/ValueSet/service-provision-conditions
HealthcareService.programexamplehttp://hl7.org/fhir/ValueSet/program
HealthcareService.communicationpreferredhttp://hl7.org/fhir/ValueSet/languages
HealthcareService.referralMethodexamplehttp://hl7.org/fhir/ValueSet/service-referral-method
HealthcareService.availableTime.daysOfWeekrequiredhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1

Constraints

Obligations

ObligationsActorElement
SHALL:able-to-populate; SHOULD:populatehttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/serverHealthcareService.identifier; HealthcareService.active; HealthcareService.providedBy; HealthcareService.type; HealthcareService.location; HealthcareService.name
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/clientHealthcareService.identifier; HealthcareService.active; HealthcareService.providedBy; HealthcareService.type; HealthcareService.location; HealthcareService.name

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.ca-csd@1.0.3-DFT | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International