healthcare services
Create Healthcare Service
post
/organizations/{organizationId}/fhir/4/HealthcareService
The details of a healthcare service available at a location.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a HealthcareService resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | External identifiers for this item. | |
active | boolean | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | |
providedBy | Reference | The organization that provides this healthcare service. | |
category | array(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 | markdown | 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 | array(HealthcareService_Eligibility) | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
program | array(CodeableConcept) | Programs that this service is applicable to. | |
characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
communication | array(CodeableConcept) | Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. | |
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/4/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* | This is a HealthcareService resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | External identifiers for this item. | |
active | boolean | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | |
providedBy | Reference | The organization that provides this healthcare service. | |
category | array(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 | markdown | 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 | array(HealthcareService_Eligibility) | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
program | array(CodeableConcept) | Programs that this service is applicable to. | |
characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
communication | array(CodeableConcept) | Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. | |
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/4/HealthcareService/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/HealthcareService/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/HealthcareService/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/HealthcareService/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/HealthcareService
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
active | string | ||
characteristic | string | ||
coverage-area | string | ||
endpoint | string | ||
identifier | string | ||
location | string | ||
name | string | ||
organization | string | ||
program | string | ||
service-category | string | ||
service-type | string | ||
specialty | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Healthcare Service
get
/organizations/{organizationId}/fhir/4/HealthcareService/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/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 | ||
characteristic | string | ||
coverage-area | string | ||
endpoint | string | ||
identifier | string | ||
location | string | ||
name | string | ||
organization | string | ||
program | string | ||
service-category | string | ||
service-type | string | ||
specialty | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a HealthcareService resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | External identifiers for this item. | |
active | boolean | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | |
providedBy | Reference | The organization that provides this healthcare service. | |
category | array(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 | markdown | 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 | array(HealthcareService_Eligibility) | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
program | array(CodeableConcept) | Programs that this service is applicable to. | |
characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
communication | array(CodeableConcept) | Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. | |
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/4/HealthcareService/{resourceId}
The details of a healthcare service available at a location.
Request
Headers
content-type* | string | application/json|application/json+fhir | 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* | This is a HealthcareService resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | External identifiers for this item. | |
active | boolean | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | |
providedBy | Reference | The organization that provides this healthcare service. | |
category | array(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 | markdown | 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 | array(HealthcareService_Eligibility) | Does this service have specific eligibility requirements that need to be met in order to use the service? | |
program | array(CodeableConcept) | Programs that this service is applicable to. | |
characteristic | array(CodeableConcept) | Collection of characteristics (attributes). | |
communication | array(CodeableConcept) | Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. | |
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