Skip to main content
Guide
DG-3051
Status
Active
Version
1.0
Created
Updated

Quick intro

Now that we have created a Location we want to add one or more Healthcare services that are delivered at that Location.

RESTful create interaction

This operation is a RESTful create interaction (type level Interaction) as described in https://www.hl7.org/fhir/http.html#create of a HealthcareService resource as profiled for Australian use and described at https://pca.digitalhealth.gov.au/fhir/4.0/currentdraft/StructureDefinition-pca-healthcare-service.html).

POST /PcaFhirApi/v2/publisher/org-6ac00cb80e4b4dbbabb489ee8a9c942b/fhir/HealthcareService HTTP/1.1
Content-Type: application/fhir+json; charset=utf-8
Accept: application/fhir+json; charset=utf-8
Authorization: Bearer 19.1649123431.965948cc22c04f6199a7d9fa6fbea0a3
User-Agent: PostmanRuntime/7.29.0
Cache-Control: no-cache
Postman-Token: 3d485caf-04c4-4a6b-8368-47c1f52c39d2
Host: pca-vendor-test.digitalhealth.gov.au
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 3458
Cookie: __cf_bm=RMLDy2NF53mmx2fa7TzWuqMc0iNAsJXYsgC_FjW.UG4-1649122250-0-ASSfEtANdPSy/agl+/W76Bb9/vXPyOid+njwoTlrOTaoi1akqBwn/osS89IPIER8OmpYFklBLsOADWM1DA2bETM=
  
{
"resourceType": "HealthcareService",
"extension": [
{
"url": "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-appointment-information",
"valueCodeableConcept": {
"coding": [
{
"system": "http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-appointment-information",
"code": "yes",
"display": "Yes"
}
]
}
},
{
"url": "http://hl7.org.au/fhir/StructureDefinition/pca-postal-address",
"valueAddress": {
"extension": [
{
"url": "http://hl7.org.au/fhir/StructureDefinition/address-identifier",
"valueIdentifier": {
"system": "http://hl7.org.au/id/gnafidentifier",
"value": "GATAS702352308"
}
}
],
"use": "work",
"line": [
"Shop 5",
"123 Tranmere Road"
],
"city": "HOWRAH",
"state": "TAS",
"postalCode": "7018",
"country": "AU"
}
}
],
"active": true,
"providedBy": {
"reference": "Organization/org-6ac00cb80e4b4dbbabb489ee8a9c942b"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-preferred",
"valueBoolean": true
}
],
"coding": [
{
"system": "http://snomed.info/sct",
"code": "700232004",
"display": "General medical service"
}
]
}
],
"specialty": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408443003",
"display": "General medical practice"
}
]
}
],
"location": [
{
"reference": "Location/loc-11b0946845354d79a265a6f5a70b7964"
}
],
"name": "HCS for jakub",
"telecom": [
{
"system": "phone",
"value": "0712345678",
"use": "work",
"rank": "1"
},
{
"system": "email",
"value": "[email protected]",
"use": "work",
"rank": "2"
}
],
"serviceProvisionCode": [
{
"coding": [
{
"system": "http://terminology.hl7.org.au/CodeSystem/service-provision-conditions",
"code": "FBB",
"display": "Fees and Bulk Billing"
}
]
}
],
"eligibility": [
{
"code": {
"coding": [
{
"system": "http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-eligibility",
"code": "age-adults",
"display": "Age - Adults"
}
]
}
}
],
"appointmentRequired": true,
"availableTime": [
{
"daysOfWeek": [
"mon",
"tue",
"wed",
"thu"
],
"allDay": false,
"availableStartTime": "09:00:00",
"_availableStartTime": {
"extension": [
{
"url": "http://terminology.hl7.org.au/ValueSet/au-timezone",
"valueString": "Australia/Brisbane"
}
]
},
"availableEndTime": "17:00:00",
"_availableEndTime": {
"extension": [
{
"url": "http://terminology.hl7.org.au/ValueSet/au-timezone",
"valueString": "Australia/Brisbane"
}
]
}
}
]
}
  
HTTP/1.1 200 OK
Date: Tue, 05 Apr 2022 01:45:40 GMT
Content-Type: application/fhir+json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Last-Modified: Tue, 05 Apr 2022 01:45:40 GMT
ETag: W/"1"
Location: HealthcareService/hcs-62b1d633f81745ba9c41e6adbfda5065/_history/1
X-XSS-Protection: 1; mode=block
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Server: cloudflare
CF-RAY: 6f6e9af22a2e5aa0-MEL
  
{"resourceType":"HealthcareService","id":"hcs-62b1d633f81745ba9c41e6adbfda5065","meta":{"versionId":"1","lastUpdated":"2022-04-05T11:45:40.4689642+10:00"},"extension":[{"url":"http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-appointment-information","valueCodeableConcept":{"coding":[{"system":"http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-appointment-information","code":"yes","display":"Yes"}]}}],"identifier":[{"system":"http://pca.digitalhealth.gov.au/id/healthcare-service","value":"hcs-62b1d633f81745ba9c41e6adbfda5065"}],"active":true,"providedBy":{"reference":"Organization/org-6ac00cb80e4b4dbbabb489ee8a9c942b"},"type":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-preferred","valueBoolean":true}],"coding":[{"system":"http://snomed.info/sct","code":"700232004","display":"General medical service"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"408443003","display":"General medical practice"}]}],"location":[{"reference":"Location/loc-11b0946845354d79a265a6f5a70b7964"}],"name":"HCS for jakub","telecom":[{"system":"phone","value":"0712345678","use":"work"},{"system":"email","value":"[email protected]","use":"work"}],"serviceProvisionCode":[{"coding":[{"system":"http://terminology.hl7.org.au/CodeSystem/service-provision-conditions","code":"FBB","display":"Fees and Bulk Billing"}]}],"eligibility":[{"code":{"coding":[{"system":"http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-eligibility","code":"age-adults","display":"Age - Adults"}]}}],"appointmentRequired":true,"availableTime":[{"daysOfWeek":["mon","tue","wed","thu"],"allDay":false,"availableStartTime":"09:00:00","_availableStartTime":{"extension":[{"url":"http://terminology.hl7.org.au/ValueSet/au-timezone","valueString":"Australia/Brisbane"}]},"availableEndTime":"17:00:00","_availableEndTime":{"extension":[{"url":"http://terminology.hl7.org.au/ValueSet/au-timezone","valueString":"Australia/Brisbane"}]}}]}

Upon successful creation of the HealthcareService the newly assigned logical id for the HealthcareService should be saved by the publishing system as they can be used as references for future operations (e.g. creating practitioner roles).

 Home | Back: Create locationNext: Search for partner services

Trade marks of the Australian Digital Health Agency: 
Provider Connect Australia™, Helping healthcare providers stay connected™

PCA logo
PCA logo

On this page