healthcare services
Create Healthcare Service
post
/organizations/{organizationId}/fhir/3/HealthcareService
The details of a healthcare service available at a location.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | HealthcareService | This is a HealthcareService resource |
| identifier | array(Identifier) | External identifiers for this item. | |
| active | boolean | Whether this healthcareservice record is in active use. | |
| providedBy | Reference | The organization that provides this healthcare service. | |
| category | CodeableConcept | Identifies the broad category of service being performed or delivered. | |
| type | array(CodeableConcept) | The specific type of service that may be delivered or performed. | |
| specialty | array(CodeableConcept) | Collection of specialties handled by the service site. This is more of a medical term. | |
| location | array(Reference) | The location(s) where this healthcare service may be provided. | |
| name | string | Further description of the service as it would be presented to a consumer while searching. | |
| comment | string | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. | |
| extraDetails | string | Extra details about the service that can't be placed in the other fields. | |
| photo | Attachment | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | |
| telecom | array(ContactPoint) | List of contacts related to this specific healthcare service. | |
| coverageArea | array(Reference) | The location(s) that this service is available to (not where the service is provided). | |
| serviceProvisionCode | array(CodeableConcept) | The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| eligibility | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
| eligibilityNote | string | Describes the eligibility conditions for the service. | |
| programName | array() | Program Names that can be used to categorize the service. | |
| characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
| referralMethod | array(CodeableConcept) | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | |
| appointmentRequired | boolean | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. | |
| availableTime | array(HealthcareService_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(HealthcareService_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
Response
keyboard_arrow_down
Patch Healthcare Service
patch
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}
The details of a healthcare service available at a location.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | HealthcareService | This is a HealthcareService resource |
| identifier | array(Identifier) | External identifiers for this item. | |
| active | boolean | Whether this healthcareservice record is in active use. | |
| providedBy | Reference | The organization that provides this healthcare service. | |
| category | CodeableConcept | Identifies the broad category of service being performed or delivered. | |
| type | array(CodeableConcept) | The specific type of service that may be delivered or performed. | |
| specialty | array(CodeableConcept) | Collection of specialties handled by the service site. This is more of a medical term. | |
| location | array(Reference) | The location(s) where this healthcare service may be provided. | |
| name | string | Further description of the service as it would be presented to a consumer while searching. | |
| comment | string | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. | |
| extraDetails | string | Extra details about the service that can't be placed in the other fields. | |
| photo | Attachment | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | |
| telecom | array(ContactPoint) | List of contacts related to this specific healthcare service. | |
| coverageArea | array(Reference) | The location(s) that this service is available to (not where the service is provided). | |
| serviceProvisionCode | array(CodeableConcept) | The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| eligibility | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
| eligibilityNote | string | Describes the eligibility conditions for the service. | |
| programName | array() | Program Names that can be used to categorize the service. | |
| characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
| referralMethod | array(CodeableConcept) | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | |
| appointmentRequired | boolean | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. | |
| availableTime | array(HealthcareService_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(HealthcareService_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
Response
keyboard_arrow_down
Read Healthcare Service
get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Healthcare Service
get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Healthcare Service
get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Healthcare Service
delete
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Healthcare Service
get
/organizations/{organizationId}/fhir/3/HealthcareService
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| category | string | ||
| characteristic | string | ||
| endpoint | string | ||
| identifier | string | ||
| location | string | ||
| name | string | ||
| organization | string | ||
| programname | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Healthcare Service
get
/organizations/{organizationId}/fhir/3/HealthcareService/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Healthcare Service
post
/organizations/{organizationId}/fhir/3/HealthcareService/_search
The details of a healthcare service available at a location.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| category | string | ||
| characteristic | string | ||
| endpoint | string | ||
| identifier | string | ||
| location | string | ||
| name | string | ||
| organization | string | ||
| programname | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | HealthcareService | This is a HealthcareService resource |
| identifier | array(Identifier) | External identifiers for this item. | |
| active | boolean | Whether this healthcareservice record is in active use. | |
| providedBy | Reference | The organization that provides this healthcare service. | |
| category | CodeableConcept | Identifies the broad category of service being performed or delivered. | |
| type | array(CodeableConcept) | The specific type of service that may be delivered or performed. | |
| specialty | array(CodeableConcept) | Collection of specialties handled by the service site. This is more of a medical term. | |
| location | array(Reference) | The location(s) where this healthcare service may be provided. | |
| name | string | Further description of the service as it would be presented to a consumer while searching. | |
| comment | string | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. | |
| extraDetails | string | Extra details about the service that can't be placed in the other fields. | |
| photo | Attachment | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | |
| telecom | array(ContactPoint) | List of contacts related to this specific healthcare service. | |
| coverageArea | array(Reference) | The location(s) that this service is available to (not where the service is provided). | |
| serviceProvisionCode | array(CodeableConcept) | The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| eligibility | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
| eligibilityNote | string | Describes the eligibility conditions for the service. | |
| programName | array() | Program Names that can be used to categorize the service. | |
| characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
| referralMethod | array(CodeableConcept) | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | |
| appointmentRequired | boolean | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. | |
| availableTime | array(HealthcareService_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(HealthcareService_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
Response
keyboard_arrow_down
Update Healthcare Service
put
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}
The details of a healthcare service available at a location.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | HealthcareService | This is a HealthcareService resource |
| identifier | array(Identifier) | External identifiers for this item. | |
| active | boolean | Whether this healthcareservice record is in active use. | |
| providedBy | Reference | The organization that provides this healthcare service. | |
| category | CodeableConcept | Identifies the broad category of service being performed or delivered. | |
| type | array(CodeableConcept) | The specific type of service that may be delivered or performed. | |
| specialty | array(CodeableConcept) | Collection of specialties handled by the service site. This is more of a medical term. | |
| location | array(Reference) | The location(s) where this healthcare service may be provided. | |
| name | string | Further description of the service as it would be presented to a consumer while searching. | |
| comment | string | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. | |
| extraDetails | string | Extra details about the service that can't be placed in the other fields. | |
| photo | Attachment | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | |
| telecom | array(ContactPoint) | List of contacts related to this specific healthcare service. | |
| coverageArea | array(Reference) | The location(s) that this service is available to (not where the service is provided). | |
| serviceProvisionCode | array(CodeableConcept) | The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| eligibility | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
| eligibilityNote | string | Describes the eligibility conditions for the service. | |
| programName | array() | Program Names that can be used to categorize the service. | |
| characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
| referralMethod | array(CodeableConcept) | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | |
| appointmentRequired | boolean | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. | |
| availableTime | array(HealthcareService_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(HealthcareService_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
Response
keyboard_arrow_down