Documentation Index
Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
Use this file to discover all available pages before exploring further.
Properties
| Name | Required | Type | Description |
|---|
| identifier | No | Identifier[] | External identifiers for this item |
| active | No | boolean | Whether this HealthcareService record is in active use |
| providedBy | No | Reference<Organization> | Organization that provides this service |
| category | No | CodeableConcept[] | Broad category of service being performed or delivered |
| type | No | CodeableConcept[] | Type of service that may be delivered or performed |
| specialty | No | CodeableConcept[] | Specialties handled by the HealthcareService |
| location | No | Reference<Location>[] | Location(s) where service may be provided |
| name | No | string | Description of service as presented to a consumer while searching |
| comment | No | string | Additional description and/or any specific issues not covered elsewhere |
| extraDetails | No | markdown | Extra details about the service that can’t be placed in the other fields |
| photo | No | Attachment | Facilitates quick identification of the service |
| telecom | No | ContactPoint[] | Contacts related to the healthcare service |
| coverageArea | No | Reference<Location>[] | Location(s) service is intended for/available to |
| serviceProvisionCode | No | CodeableConcept[] | Conditions under which service is available/offered |
| eligibility | No | HealthcareServiceEligibility | Specific eligibility requirements required to use the service |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - code | No | CodeableConcept | Coded value for the eligibility |
| - comment | No | markdown | Describes the eligibility conditions for the service |
| program | No | CodeableConcept[] | Programs that this service is applicable to |
| characteristic | No | CodeableConcept[] | Collection of characteristics (attributes) |
| communication | No | CodeableConcept[] | The language that this service is offered in |
| referralMethod | No | CodeableConcept[] | Ways that the service accepts referrals |
| appointmentRequired | No | boolean | If an appointment is required for access to this service |
| availableTime | No | HealthcareServiceAvailableTime | Times the Service Site is available |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - daysOfWeek | No | code[] | mon / tue / wed / thu / fri / sat / sun |
| - allDay | No | boolean | Always available? e.g. 24 hour service |
| - availableStartTime | No | time | Opening time of day (ignored if allDay = true) |
| - availableEndTime | No | time | Closing time of day (ignored if allDay = true) |
| notAvailable | No | HealthcareServiceNotAvailable | Not available during this time due to provided reason |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - description | Yes | string | Reason presented to the user explaining why time not available |
| - during | No | Period | Service not available from this date |
| availabilityExceptions | No | string | Description of availability exceptions |
| endpoint | No | Reference<Endpoint>[] | Technical endpoints providing access to electronic services operated for the healthcare service |
Search Parameters
| Name | Type | Description | Expression |
|---|
| active | token | The Healthcare Service is currently marked as active | HealthcareService.active |
| characteristic | token | One of the HealthcareService’s characteristics | HealthcareService.characteristic |
| coverage-area | reference | Location(s) service is intended for/available to | HealthcareService.coverageArea |
| endpoint | reference | Technical endpoints providing access to electronic services operated for the healthcare service | HealthcareService.endpoint |
| identifier | token | External identifiers for this item | HealthcareService.identifier |
| location | reference | The location of the Healthcare Service | HealthcareService.location |
| name | string | A portion of the Healthcare service name | HealthcareService.name |
| organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy |
| program | token | One of the Programs supported by this HealthcareService | HealthcareService.program |
| service-category | token | Service Category of the Healthcare Service | HealthcareService.category |
| service-type | token | The type of service provided by this healthcare service | HealthcareService.type |
| specialty | token | The specialty of the service provided by this healthcare service | HealthcareService.specialty |
Inherited Properties
| Name | Required | Type | Description |
|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
