fhir-human-services-directory
1.0.0-ballot - STU Ballot US

This page is part of the FHIR IG Human Services Directory (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: HSDSHealthcareService

Official URL: http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService Version: 1.0.0-ballot
Active as of 2022-12-08 Computable Name: HSDSHealthcareService

The HSDSHealthcareService resource describes the social and human services offered by Community-Based Organizations (CBO) at a given location. This resource may be used to encompass a variety of human and social care service interventions that assist patients and clients with unmet social needs. Examples include food, housing/shelter, income & employment, public transportation, public education, legal services, disability and aging and mental and physical health.

Usage:

Formal Views of Profile Content

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

This structure is derived from PlannetHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated 1..1instantWhen the resource version last changed
... extension:newpatients 0..*NewPatientsNew Patients
... extension:deliverymethod 0..*DeliveryMethodDelivery Method
... identifier 0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1Reference(Organization)Organization that issued id (may be just text)
... active 1..1booleanWhether this HealthcareService record is in active use
... providedBy 0..1Reference(HSDSOrganization)Organization that provides this service
... category 1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type 0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty 0..*CodeableConceptSpecialties handled by the HealthcareService
... location 0..*Reference(HSDSLocation)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..1markdownExtra 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
.... id 0..1stringUnique id for inter-element referencing
.... extension:contactpoint-availabletime 0..*ContactPointAvailableTimeContactpoint Availabletime
.... extension:via-intermediary 0..*ViaIntermediaryVia Intermediary
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... rank 0..1positiveIntSpecify preferred order of use (1 = highest)
.... period 0..1PeriodTime period when the contact point was/is in use
... coverageArea 0..*Reference(Plan-Net Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... code 0..1CodeableConceptCoded value for the eligibility
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
... communication 0..*CodeableConceptThe language that this service is offered in
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
.... 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
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... deliverymethod S0..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(HSDSOrganization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties VS (required)
... location SΣ0..*Reference(HSDSLocation)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Plan-Net Location)Location(s) service is intended 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

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


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... 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 S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
HealthcareService.identifier.userequiredFixed Value: official
HealthcareService.identifier.typeextensibleIdentifier Type Codes
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType
HealthcareService.specialtyrequiredSpecialtiesVS
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredFixed Value: work
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorHealthcareService.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... deliverymethod S0..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(HSDSOrganization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties VS (required)
... location SΣ0..*Reference(HSDSLocation)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Plan-Net Location)Location(s) service is intended 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

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


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... 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 S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.identifier.userequiredFixed Value: official
HealthcareService.identifier.typeextensibleIdentifier Type Codes
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType
HealthcareService.specialtyrequiredSpecialtiesVS
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredFixed Value: work
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorHealthcareService.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetHealthcareService

Differential View

This structure is derived from PlannetHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated 1..1instantWhen the resource version last changed
... extension:newpatients 0..*NewPatientsNew Patients
... extension:deliverymethod 0..*DeliveryMethodDelivery Method
... identifier 0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1Reference(Organization)Organization that issued id (may be just text)
... active 1..1booleanWhether this HealthcareService record is in active use
... providedBy 0..1Reference(HSDSOrganization)Organization that provides this service
... category 1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type 0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty 0..*CodeableConceptSpecialties handled by the HealthcareService
... location 0..*Reference(HSDSLocation)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..1markdownExtra 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
.... id 0..1stringUnique id for inter-element referencing
.... extension:contactpoint-availabletime 0..*ContactPointAvailableTimeContactpoint Availabletime
.... extension:via-intermediary 0..*ViaIntermediaryVia Intermediary
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... rank 0..1positiveIntSpecify preferred order of use (1 = highest)
.... period 0..1PeriodTime period when the contact point was/is in use
... coverageArea 0..*Reference(Plan-Net Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... code 0..1CodeableConceptCoded value for the eligibility
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
... communication 0..*CodeableConceptThe language that this service is offered in
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
.... 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
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... deliverymethod S0..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(HSDSOrganization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties VS (required)
... location SΣ0..*Reference(HSDSLocation)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Plan-Net Location)Location(s) service is intended 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

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


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... 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 S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
HealthcareService.identifier.userequiredFixed Value: official
HealthcareService.identifier.typeextensibleIdentifier Type Codes
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType
HealthcareService.specialtyrequiredSpecialtiesVS
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredFixed Value: work
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorHealthcareService.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*PlannetHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... deliverymethod S0..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(HSDSOrganization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Human Services Category Value Set (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: Human Services Type Value Set (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties VS (required)
... location SΣ0..*Reference(HSDSLocation)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Plan-Net Location)Location(s) service is intended 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

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


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... 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 S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.identifier.userequiredFixed Value: official
HealthcareService.identifier.typeextensibleIdentifier Type Codes
HealthcareService.categoryexampleHumanServiceCategory
HealthcareService.typeexampleHumanServiceType
HealthcareService.specialtyrequiredSpecialtiesVS
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredFixed Value: work
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorHealthcareService.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetHealthcareService

 

Other representations of profile: CSV, Excel, Schematron