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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringHealthcareServiceThis is a HealthcareService resource
identifierarray(Identifier)External identifiers for this item.
activebooleanWhether this healthcareservice record is in active use.
providedByReferenceThe organization that provides this healthcare service.
categoryCodeableConceptIdentifies the broad category of service being performed or delivered.
typearray(CodeableConcept)The specific type of service that may be delivered or performed.
specialtyarray(CodeableConcept)Collection of specialties handled by the service site. This is more of a medical term.
locationarray(Reference)The location(s) where this healthcare service may be provided.
namestringFurther description of the service as it would be presented to a consumer while searching.
commentstringAny 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.
extraDetailsstringExtra details about the service that can't be placed in the other fields.
photoAttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
telecomarray(ContactPoint)List of contacts related to this specific healthcare service.
coverageAreaarray(Reference)The location(s) that this service is available to (not where the service is provided).
serviceProvisionCodearray(CodeableConcept)The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibilityCodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service?
eligibilityNotestringDescribes the eligibility conditions for the service.
programNamearray()Program Names that can be used to categorize the service.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
referralMethodarray(CodeableConcept)Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
appointmentRequiredbooleanIndicates 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.
availableTimearray(HealthcareService_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(HealthcareService_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA 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.
endpointarray(Reference)Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Response

Patch Healthcare Service

patch
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}

The details of a healthcare service available at a location.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringHealthcareServiceThis is a HealthcareService resource
identifierarray(Identifier)External identifiers for this item.
activebooleanWhether this healthcareservice record is in active use.
providedByReferenceThe organization that provides this healthcare service.
categoryCodeableConceptIdentifies the broad category of service being performed or delivered.
typearray(CodeableConcept)The specific type of service that may be delivered or performed.
specialtyarray(CodeableConcept)Collection of specialties handled by the service site. This is more of a medical term.
locationarray(Reference)The location(s) where this healthcare service may be provided.
namestringFurther description of the service as it would be presented to a consumer while searching.
commentstringAny 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.
extraDetailsstringExtra details about the service that can't be placed in the other fields.
photoAttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
telecomarray(ContactPoint)List of contacts related to this specific healthcare service.
coverageAreaarray(Reference)The location(s) that this service is available to (not where the service is provided).
serviceProvisionCodearray(CodeableConcept)The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibilityCodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service?
eligibilityNotestringDescribes the eligibility conditions for the service.
programNamearray()Program Names that can be used to categorize the service.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
referralMethodarray(CodeableConcept)Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
appointmentRequiredbooleanIndicates 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.
availableTimearray(HealthcareService_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(HealthcareService_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA 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.
endpointarray(Reference)Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Response

Read Healthcare Service

get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Healthcare Service

get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Healthcare Service

get
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Healthcare Service

delete
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Healthcare Service

get
/organizations/{organizationId}/fhir/3/HealthcareService

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
categorystring
characteristicstring
endpointstring
identifierstring
locationstring
namestring
organizationstring
programnamestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Healthcare Service

get
/organizations/{organizationId}/fhir/3/HealthcareService/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
categorystring
characteristicstring
endpointstring
identifierstring
locationstring
namestring
organizationstring
programnamestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringHealthcareServiceThis is a HealthcareService resource
identifierarray(Identifier)External identifiers for this item.
activebooleanWhether this healthcareservice record is in active use.
providedByReferenceThe organization that provides this healthcare service.
categoryCodeableConceptIdentifies the broad category of service being performed or delivered.
typearray(CodeableConcept)The specific type of service that may be delivered or performed.
specialtyarray(CodeableConcept)Collection of specialties handled by the service site. This is more of a medical term.
locationarray(Reference)The location(s) where this healthcare service may be provided.
namestringFurther description of the service as it would be presented to a consumer while searching.
commentstringAny 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.
extraDetailsstringExtra details about the service that can't be placed in the other fields.
photoAttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
telecomarray(ContactPoint)List of contacts related to this specific healthcare service.
coverageAreaarray(Reference)The location(s) that this service is available to (not where the service is provided).
serviceProvisionCodearray(CodeableConcept)The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibilityCodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service?
eligibilityNotestringDescribes the eligibility conditions for the service.
programNamearray()Program Names that can be used to categorize the service.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
referralMethodarray(CodeableConcept)Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
appointmentRequiredbooleanIndicates 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.
availableTimearray(HealthcareService_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(HealthcareService_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA 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.
endpointarray(Reference)Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Response

Update Healthcare Service

put
/organizations/{organizationId}/fhir/3/HealthcareService/{resourceId}

The details of a healthcare service available at a location.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringHealthcareServiceThis is a HealthcareService resource
identifierarray(Identifier)External identifiers for this item.
activebooleanWhether this healthcareservice record is in active use.
providedByReferenceThe organization that provides this healthcare service.
categoryCodeableConceptIdentifies the broad category of service being performed or delivered.
typearray(CodeableConcept)The specific type of service that may be delivered or performed.
specialtyarray(CodeableConcept)Collection of specialties handled by the service site. This is more of a medical term.
locationarray(Reference)The location(s) where this healthcare service may be provided.
namestringFurther description of the service as it would be presented to a consumer while searching.
commentstringAny 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.
extraDetailsstringExtra details about the service that can't be placed in the other fields.
photoAttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
telecomarray(ContactPoint)List of contacts related to this specific healthcare service.
coverageAreaarray(Reference)The location(s) that this service is available to (not where the service is provided).
serviceProvisionCodearray(CodeableConcept)The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibilityCodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service?
eligibilityNotestringDescribes the eligibility conditions for the service.
programNamearray()Program Names that can be used to categorize the service.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
referralMethodarray(CodeableConcept)Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
appointmentRequiredbooleanIndicates 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.
availableTimearray(HealthcareService_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(HealthcareService_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA 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.
endpointarray(Reference)Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Response