Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.

Resource Profile: CareConnectHealthcareService1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1 Version: 0.1.0
Draft as of 2018-09-27 Computable Name: CareConnect-HealthcareService-1

Copyright/Legal: Copyright © 2018 NHS Digital

CareConnect HealthCareService Profile

NOT CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

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

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... identifier 1..1IdentifierExternal identifiers for this item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal identifiers for this item

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorHealthcareServiceIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.

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


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


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


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPractice Setting Code Value Set
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibilityexample
HealthcareService.characteristicexample
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from HealthcareService

Summary

Mandatory: 1 element

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... identifier 1..1IdentifierExternal identifiers for this item

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal identifiers for this item

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorHealthcareServiceIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.

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


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


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


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPractice Setting Code Value Set
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibilityexample
HealthcareService.characteristicexample
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from HealthcareService

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron