8.8 Resource HealthcareService - Content

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	TU		DomainResource	The details of a healthcare service available at a location Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier	Σ	0..*	Identifier	External identifiers for this item
active	?! Σ	0..1	boolean	Whether this HealthcareService record is in active use
providedBy	Σ	0..1	Reference ( Organization )	Organization that provides this service
category offeredIn		0..*	Reference ( HealthcareService )	The service within which this service is offered
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory Service Category ( Example )
type	Σ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: ServiceType Service Type ( Example )
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set ( Preferred )
location	Σ	0..*	Reference ( Location )	Location(s) where service may be provided
name	Σ	0..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string markdown	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom contact		0..*	ContactPoint ExtendedContactDetail	Official contact details for the healthcare service HealthcareService
coverageArea		0..*	Reference ( Location )	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions Service Provision Conditions ( Example )
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
code		0..1	CodeableConcept	Coded value for the eligibility Binding: ServiceEligibility ( Example )
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program ( Example )
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) ServiceCharacteristic Binding: Service Mode ( Example )
communication		0..*	CodeableConcept	The language that this service is offered in Common Binding: All Languages ( Preferred but limited to AllLanguages Required ) referralMethod 0..* Ways that the service accepts referrals ReferralMethod ( Example ) appointmentRequired 0..1 If an appointment is required for access to this service availableTime 0..* BackboneElement CodeableConcept Additional Bindings Purpose Common Languages boolean Starter Set Times the Service Site is available
daysOfWeek referralMethod		0..*	code CodeableConcept	mon | tue | wed | thu | fri | sat | sun Ways that the service accepts referrals DaysOfWeek Binding: Referral Method ( Required Example )
allDay appointmentRequired		0..1	boolean	Always available? e.g. 24 hour If an appointment is required for access to this service availableStartTime 0..1 time Opening time of day (ignored if allDay = true) availableEndTime 0..1 time
notAvailable availability		0..*	BackboneElement Availability	Not available during this time due to provided reason description 1..1 string Reason presented to Times the user explaining why time not healthcare service is available during 0..1 Period (including exceptions) Service not available from this date
endpoint		0..*	Reference ( Endpoint )	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

See the Extensions for this resource

<HealthcareService xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifiers for this item --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this HealthcareService record is in active use -->
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn>

 <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category>
 <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type>
 <</specialty>

 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>

 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <name value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching -->
 <

 <comment value="[markdown]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere -->

 <extraDetails value="[markdown]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo>
 <</telecom>

 <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact>

 <coverageArea><!-- 0..* Reference(Location) Location(s) service is intended for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <eligibility>  <!-- 0..* Specific eligibility requirements required to use the service -->
  <code><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>
 <</characteristic>
 <</communication>

 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>

 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <
  <
  <
  <
  <
 </availableTime>
 <
  <
  <</during>
 </notAvailable>
 <

 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>

 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>
</HealthcareService>

{
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifiers for this item
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered

  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "

  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService

  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "

  "comment" : "<markdown>", // Additional description and/or any specific issues not covered elsewhere

  "extraDetails" : "<markdown>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // Facilitates quick identification of the service
  "

  "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService

  "coverageArea" : [{ Reference(Location) }], // Location(s) service is intended for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "eligibility" : [{ // Specific eligibility requirements required to use the service
    "code" : { CodeableConcept }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to
  "
  "

  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in

  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "
    "
    "
    "
    "
  }],
  "
    "
    "
  }],
  "

  "availability" : [{ Availability }], // Times the healthcare service is available (including exceptions)

  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:HealthcareService;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifiers for this item
  fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use
  fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service
  fhir:offeredIn  ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered
  fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided
  fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching
  fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields
  fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService
  fhir:coverageArea  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to
  fhir:serviceProvisionCode  ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered
  fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service
    fhir:code [ CodeableConcept ] ; # 0..1 Coded value for the eligibility
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
  ] ... ) ;
  fhir:program  ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in
  fhir:referralMethod  ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals
  fhir:appointmentRequired [ boolean ] ; # 0..1 If an appointment is required for access to this service
  fhir:availability  ( [ Availability ] ... ) ; # 0..* Times the healthcare service is available (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service

]

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	TU		DomainResource	The details of a healthcare service available at a location Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier	Σ	0..*	Identifier	External identifiers for this item
active	?! Σ	0..1	boolean	Whether this HealthcareService record is in active use
providedBy	Σ	0..1	Reference ( Organization )	Organization that provides this service
category offeredIn		0..*	Reference ( HealthcareService )	The service within which this service is offered
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory Service Category ( Example )
type	Σ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: ServiceType Service Type ( Example )
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set ( Preferred )
location	Σ	0..*	Reference ( Location )	Location(s) where service may be provided
name	Σ	0..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string markdown	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom contact		0..*	ContactPoint ExtendedContactDetail	Official contact details for the healthcare service HealthcareService
coverageArea		0..*	Reference ( Location )	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions Service Provision Conditions ( Example )
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
code		0..1	CodeableConcept	Coded value for the eligibility Binding: ServiceEligibility ( Example )
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program ( Example )
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) ServiceCharacteristic Binding: Service Mode ( Example )
communication		0..*	CodeableConcept	The language that this service is offered in Common Binding: All Languages ( Preferred but limited to AllLanguages Required ) referralMethod 0..* Ways that the service accepts referrals ReferralMethod ( Example ) appointmentRequired 0..1 If an appointment is required for access to this service availableTime 0..* BackboneElement CodeableConcept Additional Bindings Purpose Common Languages boolean Starter Set Times the Service Site is available
daysOfWeek referralMethod		0..*	code CodeableConcept	mon | tue | wed | thu | fri | sat | sun Ways that the service accepts referrals DaysOfWeek Binding: Referral Method ( Required Example )
allDay appointmentRequired		0..1	boolean	Always available? e.g. 24 hour If an appointment is required for access to this service availableStartTime 0..1 time
notAvailable availability		0..*	BackboneElement Availability	Not available during this time due to provided reason description 1..1 string Reason presented to Times the user explaining why time not healthcare service is available during 0..1 Period (including exceptions) Service not available from this date
endpoint		0..*	Reference ( Endpoint )	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

See the Extensions for this resource

<HealthcareService xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External identifiers for this item --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this HealthcareService record is in active use -->
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn>

 <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category>
 <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type>
 <</specialty>

 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>

 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <name value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching -->
 <

 <comment value="[markdown]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere -->

 <extraDetails value="[markdown]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo>
 <</telecom>

 <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact>

 <coverageArea><!-- 0..* Reference(Location) Location(s) service is intended for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <eligibility>  <!-- 0..* Specific eligibility requirements required to use the service -->
  <code><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>
 <</characteristic>
 <</communication>

 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>

 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <
  <
  <
  <
  <
 </availableTime>
 <
  <
  <</during>
 </notAvailable>
 <

 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>

 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>
</HealthcareService>

{
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifiers for this item
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered

  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "

  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService

  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "

  "comment" : "<markdown>", // Additional description and/or any specific issues not covered elsewhere

  "extraDetails" : "<markdown>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // Facilitates quick identification of the service
  "

  "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService

  "coverageArea" : [{ Reference(Location) }], // Location(s) service is intended for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "eligibility" : [{ // Specific eligibility requirements required to use the service
    "code" : { CodeableConcept }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to
  "
  "

  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in

  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "
    "
    "
    "
    "
  }],
  "
    "
    "
  }],
  "

  "availability" : [{ Availability }], // Times the healthcare service is available (including exceptions)

  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:HealthcareService;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifiers for this item
  fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use
  fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service
  fhir:offeredIn  ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered
  fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided
  fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching
  fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields
  fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService
  fhir:coverageArea  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to
  fhir:serviceProvisionCode  ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered
  fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service
    fhir:code [ CodeableConcept ] ; # 0..1 Coded value for the eligibility
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
  ] ... ) ;
  fhir:program  ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in
  fhir:referralMethod  ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals
  fhir:appointmentRequired [ boolean ] ; # 0..1 If an appointment is required for access to this service
  fhir:availability  ( [ Availability ] ... ) ; # 0..* Times the healthcare service is available (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service

]

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )