DaVinci PDEX Plan Net STU Ballot

This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

HealthcareService

 

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService

The HealthCareService resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnstics, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

This profile builds on HealthcareService.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a draft by HL7 Financial Management WG.

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 46 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.HealthcareService maps to HealthcareService:
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  HealthcareServiceProvidedBy maps to providedBy
  HealthcareServiceLocation maps to location
  HealthcareServiceType maps to type
  NewPatients maps to extension
  NAvailableTime maps to availableTime
  NAvailableTime.DaysOfWeek maps to availableTime.daysOfWeek
  NAvailableTime.AllDay maps to availableTime.allDay
  NAvailableTime.AvailableStartTime maps to availableTime.availableStartTime
  NAvailableTime.AvailableEndTime maps to availableTime.availableEndTime
  TAvailableTime maps to telecom.extension
  TViaIntermediary maps to telecom.extension
  NotAvailable maps to notAvailable
  NotAvailable.Description maps to notAvailable.description
  NotAvailable.DuringPeriod maps to notAvailable.during
  HealthcareServiceEndpoint maps to endpoint
  HealthcareServiceEligibility maps to eligibility
  HealthcareServiceEligibility.EligibilityCode maps to eligibility.code
  HealthcareServiceEligibility.EligibilityID maps to eligibility.id
  HealthcareServiceEligibility.ExtraDetails maps to eligibility.comment
  HealthcareServiceCharacteristic maps to characteristic
  HealthcareServiceCommunication maps to communication
  HealthcareServiceTelecom maps to telecom
  HealthcareServiceTelecom.ContactPoint.Purpose maps to telecom.use
  HealthcareServiceTelecom.ContactPoint.PriorityRank maps to telecom.rank
  HealthcareServiceTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  HealthcareServiceTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  HealthcareServiceTelecom.ContactPoint.Type maps to telecom.system
  HealthcareServiceActive maps to active
  HealthcareServiceCategory maps to category
  CoverageArea maps to coverageArea
  HealthcareServiceSpecialty maps to specialty
  HealthcareServiceName maps to name
  Comment maps to comment
  ExtraDetails maps to extraDetails
  HealthcareServicePhoto maps to photo
  HealthcareServiceProvisionCode maps to serviceProvisionCode
  AppointmentRequired maps to appointmentRequired
  ReferralMethod maps to referralMethod
  Program maps to program
  AvailabilityExceptions maps to availabilityExceptions
  constrain eligibility.code to 0..1
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService plannet-HealthcareService
... extension 1..*Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S1..1(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... providedBy SReference(plannet-Organization)
... category S
... type S
... specialty S
... location SReference(plannet-Location)
... name S
... comment S
... extraDetails S
... photo S
... telecom S
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system S
.... value S
.... use S
.... rank S
.... period S
... coverageArea SReference(plannet-Location)
... serviceProvisionCode S
... eligibility S
.... id S
.... code S
.... comment S
... program S
... characteristic S
... communication S
... referralMethod S
... appointmentRequired S
... availableTime S
.... daysOfWeek S
.... allDay S
.... availableStartTime S
.... availableEndTime S
... notAvailable S
.... description S
.... during S
... availabilityExceptions S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*plannet-HealthcareService
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S1..1(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... 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 ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣ0..1Reference(plannet-Organization)Organization that provides this service
... category SΣ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(plannet-Location)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 S0..1markdownExtra details about the service that can't be placed in the other fields
... photo SΣ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ0..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(plannet-Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... eligibility SI0..*BackboneElementSpecific eligibility requirements required to use the service
.... id S0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example)
.... comment S0..1markdownDescribes the eligibility conditions for the service
... program S0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example)
... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SI0..*BackboneElementTimes the Service Site is available
.... 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
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... 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 SI0..*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(plannet-Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 46 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.HealthcareService maps to HealthcareService:
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  HealthcareServiceProvidedBy maps to providedBy
  HealthcareServiceLocation maps to location
  HealthcareServiceType maps to type
  NewPatients maps to extension
  NAvailableTime maps to availableTime
  NAvailableTime.DaysOfWeek maps to availableTime.daysOfWeek
  NAvailableTime.AllDay maps to availableTime.allDay
  NAvailableTime.AvailableStartTime maps to availableTime.availableStartTime
  NAvailableTime.AvailableEndTime maps to availableTime.availableEndTime
  TAvailableTime maps to telecom.extension
  TViaIntermediary maps to telecom.extension
  NotAvailable maps to notAvailable
  NotAvailable.Description maps to notAvailable.description
  NotAvailable.DuringPeriod maps to notAvailable.during
  HealthcareServiceEndpoint maps to endpoint
  HealthcareServiceEligibility maps to eligibility
  HealthcareServiceEligibility.EligibilityCode maps to eligibility.code
  HealthcareServiceEligibility.EligibilityID maps to eligibility.id
  HealthcareServiceEligibility.ExtraDetails maps to eligibility.comment
  HealthcareServiceCharacteristic maps to characteristic
  HealthcareServiceCommunication maps to communication
  HealthcareServiceTelecom maps to telecom
  HealthcareServiceTelecom.ContactPoint.Purpose maps to telecom.use
  HealthcareServiceTelecom.ContactPoint.PriorityRank maps to telecom.rank
  HealthcareServiceTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  HealthcareServiceTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  HealthcareServiceTelecom.ContactPoint.Type maps to telecom.system
  HealthcareServiceActive maps to active
  HealthcareServiceCategory maps to category
  CoverageArea maps to coverageArea
  HealthcareServiceSpecialty maps to specialty
  HealthcareServiceName maps to name
  Comment maps to comment
  ExtraDetails maps to extraDetails
  HealthcareServicePhoto maps to photo
  HealthcareServiceProvisionCode maps to serviceProvisionCode
  AppointmentRequired maps to appointmentRequired
  ReferralMethod maps to referralMethod
  Program maps to program
  AvailabilityExceptions maps to availabilityExceptions
  constrain eligibility.code to 0..1

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService plannet-HealthcareService
... extension 1..*Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S1..1(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... providedBy SReference(plannet-Organization)
... category S
... type S
... specialty S
... location SReference(plannet-Location)
... name S
... comment S
... extraDetails S
... photo S
... telecom S
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system S
.... value S
.... use S
.... rank S
.... period S
... coverageArea SReference(plannet-Location)
... serviceProvisionCode S
... eligibility S
.... id S
.... code S
.... comment S
... program S
... characteristic S
... communication S
... referralMethod S
... appointmentRequired S
... availableTime S
.... daysOfWeek S
.... allDay S
.... availableStartTime S
.... availableEndTime S
... notAvailable S
.... description S
.... during S
... availabilityExceptions S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*plannet-HealthcareService
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S1..1(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... 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 ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣ0..1Reference(plannet-Organization)Organization that provides this service
... category SΣ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(plannet-Location)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 S0..1markdownExtra details about the service that can't be placed in the other fields
... photo SΣ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ0..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(plannet-Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... eligibility SI0..*BackboneElementSpecific eligibility requirements required to use the service
.... id S0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example)
.... comment S0..1markdownDescribes the eligibility conditions for the service
... program S0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example)
... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SI0..*BackboneElementTimes the Service Site is available
.... 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
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... 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 SI0..*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(plannet-Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
HealthcareService.languagepreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.identifier.userequiredIdentifierUse
HealthcareService.identifier.typeextensibleIdentifier Type Codes
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredContactPointUse
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

 

Constraints

IdPathDetailsRequirements
dom-2HealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4HealthcareServiceIf 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-3HealthcareServiceIf 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-6HealthcareServiceA resource should have narrative for robust management
: text.div.exists()
dom-5HealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1HealthcareService.eligibilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HealthcareService.availableTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1HealthcareService.notAvailableAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())