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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a HealthcareService resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)External identifiers for this item.
activebooleanThis 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.
providedByReferenceThe organization that provides this healthcare service.
categoryarray(CodeableConcept)Identifies 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.
extraDetailsmarkdownExtra 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.
eligibilityarray(HealthcareService_Eligibility)Does this service have specific eligibility requirements that need to be met in order to use the service?
programarray(CodeableConcept)Programs that this service is applicable to.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
communicationarray(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.
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/4/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*This is a HealthcareService resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)External identifiers for this item.
activebooleanThis 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.
providedByReferenceThe organization that provides this healthcare service.
categoryarray(CodeableConcept)Identifies 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.
extraDetailsmarkdownExtra 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.
eligibilityarray(HealthcareService_Eligibility)Does this service have specific eligibility requirements that need to be met in order to use the service?
programarray(CodeableConcept)Programs that this service is applicable to.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
communicationarray(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.
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/4/HealthcareService/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Healthcare Service

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/HealthcareService/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Healthcare Service

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Healthcare Service

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

Request

Headers

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

Query params

_idstring
_languagestring
activestring
characteristicstring
coverage-areastring
endpointstring
identifierstring
locationstring
namestring
organizationstring
programstring
service-categorystring
service-typestring
specialtystring

Params

organizationId*string|stringid|slug

Response

Search History Healthcare Service

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
characteristicstring
coverage-areastring
endpointstring
identifierstring
locationstring
namestring
organizationstring
programstring
service-categorystring
service-typestring
specialtystring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a HealthcareService resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)External identifiers for this item.
activebooleanThis 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.
providedByReferenceThe organization that provides this healthcare service.
categoryarray(CodeableConcept)Identifies 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.
extraDetailsmarkdownExtra 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.
eligibilityarray(HealthcareService_Eligibility)Does this service have specific eligibility requirements that need to be met in order to use the service?
programarray(CodeableConcept)Programs that this service is applicable to.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
communicationarray(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.
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/4/HealthcareService/{resourceId}

The details of a healthcare service available at a location.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a HealthcareService resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)External identifiers for this item.
activebooleanThis 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.
providedByReferenceThe organization that provides this healthcare service.
categoryarray(CodeableConcept)Identifies 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.
extraDetailsmarkdownExtra 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.
eligibilityarray(HealthcareService_Eligibility)Does this service have specific eligibility requirements that need to be met in order to use the service?
programarray(CodeableConcept)Programs that this service is applicable to.
characteristicarray(CodeableConcept)Collection of characteristics (attributes).
communicationarray(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.
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