Generated Narrative: CapabilityStatement pca-publisher-agent
application/fhir+json, application/fhir+xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverA PCA Publisher Agent manages the service offerings for one publisher organisation.
\nThe PCA service instantiates one PCA Publisher Agent for each participating publisher organisation. That is, each publisher organisation interacts with a PCA Publisher Agent located at a publisher agent base URL that is unique to that organisation.
\nThe publisher agent base URL for a particular organisation is available via the PCA portal on the 'Organisation Details' screen of the publisher organisation.
\nPublication process
\nA PCA Publisher Agent creates the Location, HealthcareService and PractitionerRole resources (that are associated with existing Organization and Practitioner resources) that represent their service offerings. These resources are made available to a subscriber organisation when a publisher authorises publication of a HealthcareService or PractitionerRole resource to one or more of the subscriber organisation's partner services.
The authority to publish is represented using Contract resources which are also implemented by the PCA Publisher Agent (see the Contract resource endpoint).
Identifier disclosure rules
\nThe PCA service enforces certain business rules regarding the disclosure of Identifiers (including subscriber-issued identifiers) in the resources that it makes available to subscribers.
\nThe result of these rules may be that a copy of a resource received by one subscriber may contain Identifiers that are not included in the copy of the same resource that is received by a different subscriber.
\nIn the case of HPI-Is these identifier disclosure rules ensure that relevant legal requirements are complied with.
\nOther identifier disclosure rules are defined by the PCA operator.
\nThe identifier disclosure rules are applied automatically at the time that the resource is retrieved by the target PCA Subscriber Agent.
\nAuthorisation rules
\nAuthorised client systems are only permitted to interact with a PCA Publisher Agent API where the participating organisation associated with the PCA Publisher Agent has a publisher approval status of 'Approved'.
\nResource profiles and extensions
\nThis API specification defines the required resource profiles for each operation. In addition, the PCA Publisher Agent will reject any request to create or update a resource that contains any extensions (including modifier extensions) not explicitly defined in that resource profile.
\nOAuthThis server implements OAuth2
\n
search-systeminteraction described as follows:Definition:
\nThis operation is a RESTful search interaction (whole system interaction), across multiple resource types (as described in the FHIR specification).
Behaviour:
\nThis operation is used by a client system operated by a publisher organisation to get resources that match the specified search parameters and that are within the scope of the publisher organisation.
The following search parameters are supported:
\n_lastUpdated is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with PCA Publisher Agent. This search parameter supports the gt and lt comparison prefixes.
_type is used to filter the resources returned by their resource type. The available types are:
\nHealthcareService (returns resources conforming to the PCA Healthcare Service profile)PractitionerRole (returns resources conforming to the PCA Practitioner Role profile)Organization (returns resources conforming to the PCA Organization profile)Location (returns resources conforming to the PCA Location profile)Practitioner (returns resources conforming to the PCA Practitioner profile)Provenance (returns resources conforming to the PCA Provenance profile)Contract (returns resources conforming to the PCA Publication Authorisation Record profile)Task (returns resources conforming to the PCA Match Record profile)_include (and _include:iterate) are used in order that all the resources that match the _lastUpdated and _type filters will be accompanied, in the result Bundle, with all the other resources which they reference (directly or indirectly).
\nNote that the use of _include (and _include:iterate) means that a resource may be present in the result Bundle either because it matched the other query parameters or because it was referenced (possibly indirectly) by another resource that matched the other query parameters.
All of the following query parameters are required in order to receive the complete set of resources that have been created or changed since [last_synchronized]:
\n_lastUpdated=[last_synchronized]
\n_type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance,Contract,Task
\n_include=Location:organization
\n_include=HealthcareService:organization
\n_include=HealthcareService:location
\n_include=PractitionerRole:organization
\n_include=PractitionerRole:location
\n_include=PractitionerRole:service
\n_include=PractitionerRole:practitioner
\n_include=Provenance:target
\n_include=Contract:subject
\n_include:iterate=HealthcareService:organization
\n_include:iterate=HealthcareService:location
\n_include:iterate=PractitionerRole:organization
\n_include:iterate=PractitionerRole:location
\n_include:iterate=PractitionerRole:service
\n_include:iterate=PractitionerRole:practitioner
This operation supports 'paging' (see FHIR specification). If there are too many resources to return in one Bundle, the FHIR server adds a next link to the response Bundle. The contents of the result Bundle therefore comprise all instances of the requested resource types whose lastUpdated timestamp is greater than the <lastSync> in the request query expression and less than or equal to <lastInBundle> where <lastInBundle> is the greatest lastUpdated value of all resources included in the result Bundle. The Publisher Agent FHIR server sets the next link to the filter expression that was used in the original request except that <lastSync> is replaced with <lastInBundle>. If the next link is not present in the Bundle, then there are no more service offerings available.
HTTP interaction signature:
\nGET [publisher agent base url]/?[parameters]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nSuccess: Bundle that contains zero to many resources (where the resource type was included in the filter expression of the search request) that conform to the following PCA profiles:
HealthcareService resources conforming to the PCA Healthcare Service profilePractitionerRole resources conforming to the PCA Practitioner Role profileOrganization resources conforming to the PCA Organization profileLocation resources conforming to the PCA Location profilePractitioner resources conforming to the PCA Practitioner profileProvenance resources conforming to the PCA Provenance profileContract resources conforming to the PCA Publication Authorisation Record profileTask resources conforming to the PCA Match Record profileError: OperationOutcome resource (see FHIR specification).
Required OAuth 2.0 scopes:
\nThe scope string SHALL contain the following scoped role:
\nOrganization/[id]:PS_ReadWhere [id] SHALL identify the Organization associated with the target PCA Publisher Agent.
Response Codes:
\nThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Organization | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization | y | |||||||
| Location | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-location | y | y | y | organization, status, _lastUpdated | ||||
| HealthcareService | y | y | y | y | _profile, active, organization, service-catgeory, coverage-area.location.address-postalcode | ||||
| PractitionerRole | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role | y | y | y | _lastUpdated, _id, active, identifier, organization, practitioner, service | ||||
| Practitioner | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner | y | y | identifier | |||||
| Provenance | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-provenance | y | |||||||
| Contract | y | y | y | y | _profile, subject, version | ||||
| Task | http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-match-record | y |
readDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of an Organization resource.
Behaviour:
\nThis operation retrieves an identified Organization resource that conforms to the PCA Organization profile.
HTTP interaction signature:
\nGET [publisher agent base url]/Organization/[id]
Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the Organization resource returned.Response Body:
\nOrganization resource that conforms to the PCA Organization profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the target Organization being read.
if a scoped role identifies a Location then [id] SHALL identify any Location where its managingOrganisation references the target Organization being read.
if a scoped role identifies a HealthcareService then [id] SHALL identify any HealthcareService where its providedBy references the target Organization being read.
Response Codes:
\nThis section defines the supported interactions for the PCA Organization profile of the
\nOrganizationresource type.
createDefinition:
\nThis operation is a RESTful create interaction (as described in the FHIR specification) of a Location resource conforming to the PCA Location profile.
Behaviour:
\nIf any of the following data validation rules are violated in the input resource then the request is rejected and the error code 422 is returned:
\nOrganization within the scope of the requesting system.HTTP interaction signature:
\nPOST [publisher agent base url]/LocationMandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nLocation resource that conforms to the PCA Location profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the new Location resource.Response Body:
\nLocation resource that conforms to the PCA Location profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain the following scoped role:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Organization/[id]:PS_ServicesMgrWhere [id] SHALL identify the Organization referenced by managingOrganization in the new Location.
Response Codes:
\nreadDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a Location resource.
Behaviour:
\nThis operation retrieves an identified Location resource that conforms to the PCA Location profile.
HTTP interaction signature:
\nGET [publisher agent base url]/Location/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the Location resource returned.Response Body:
\nLocation resource that conforms to the PCA Location profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain the following scoped role:
\nOrganization/[id]:PCA:OmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by managingOrganization in the target Location being read.
if a scoped role identifies a Location then [id] SHALL identify the Location being read.
if a scoped role identifies a HealthcareService then [id] SHALL identify a HealthcareService where its location references the target Location being read.
Response Codes:
\nupdateDefinition:
\nThis operation is a RESTful update interaction (as described in the FHIR specification) of a Location resource.
Behaviour:
\nIf any of the following data validation rules are violated in the input resource, then the request is rejected and the error code 422 is returned:
\nLocation identified in the 'if-match' HTTP header.Location identified in the 'if-match' HTTP header.Location identified in the 'if-match' HTTP header.If the 'if-match' HTTP header is not provided in the request, then the PCA Publisher Agent will reject the request and return the error code 400.
\nIf the 'if-match' HTTP header does not match the current version, then the PCA Publisher Agent will reject the request and return the error code 412.
\nHTTP interaction signature:
\nPUT [publisher agent base url]/Location/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]if-match [version id] where [version id] is the version of the Location being updated.Request Body:
\nLocation resource that conforms to the PCA Location profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the Location resource returned.Response Body:
\nLocation resource that conforms to the PCA Location profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Location/[id]:PCA:Hsm Organization/[id]:PS_ServiceMgr Location/[id]:PS_ServiceMgrIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by managingOrganization in the target Location being updated.
If a scoped role identifies a Location then [id] SHALL identify the target Location being updated.
Response Codes:
\nThis section defines the supported interactions for the PCA Location profile of the
\nLocationresource type.A
\nLocationresource conforming to the PCA Location profile represents a location at which healthcare services are offered by a PCA publisher.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | organization | reference | |
| SHALL | status | token | |
| SHALL | _lastUpdated | date |
createDefinition:
\nThis operation is a RESTful create interaction (as described in the FHIR specification) of a HealthcareService resource conforming to the PCA Healthcare Service profile.
Behaviour:
\nIf any of the following data validation rules are violated in the input resource then the request is rejected and the error code 422 is returned:
\nOrganization within the scope of the requesting system.Location within the scope of the requesting system.Location for which managingOrganization references the same Organization as is referenced by providedBy.PractitionerRole`` resources that reference this HealthcareService```.PractitionerRole`` resources that reference this HealthcareService```.PCA Healthcare Service resources for the same PCA Location.HTTP interaction signature:
\nPOST [publisher agent base url]/HealthcareServiceMandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nHealthcareService resource that conforms to the PCA Healthcare Service profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the new HealthcareService resource.Response Body:
\nHealthcareService resource that conforms to the PCA Healthcare Service profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Location/[id]:PCA:Hsm Organization/[id]:PS_ServicesMgr Location/[id]:PS_ServicesMgrIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by providedBy in the new HealthcareService.
if a scoped role identifies a Location then [id] SHALL identify the Location referenced by location in the new HealthcareService.
Response Codes:
\nreadDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a HealthcareService resource.
Behaviour:
\nThis operation is used to retrieve an identified HealthcareService resource that conforms to one of the following profiles:
Different authorisation rules apply depending on the profile of the HealthcareService resource being retrieved; see the 'Required OAuth 2.0 scopes' section below.
HTTP interaction signature:
\nGET [publisher agent base url]/HealthcareService/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the HealthcareService resource returned.Response Body:
\nHealthcareService resource that conforms to either the PCA Healthcare Service or PCA Partner Service profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PS_Read Location/[id]:PS_Read HealthcareService/[id]:PS_ReadWhen retrieving a HealthcareService resource that conforms to the PCA Healthcare Service profile:
Organization then [id] SHALL identify the Organization referenced by providedBy in the target HealthcareService being read.Location then [id] SHALL identify the Location referenced by location in the target HealthcareService being read.HealthcareService then [id] SHALL identify the target HealthcareService being read.When retrieving a HealthcareService resource that conforms to the PCA Partner Service profile:
Organization then [id] SHALL identify the publishing organisation associated with the target PCA Publisher Agent.Location then [id] SHALL identify any existing Location within the scope of the requesting system.HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.Response Codes:
\nupdateDefinition:
\nThis operation is a RESTful update interaction (as described in the FHIR specification) of a HealthcareService resource.
Behaviour:
\nIf any of the following data validation rules are violated in the input resource, then the request is rejected and the error code 422 is returned:
\nHealthcareService identified in the 'if-match' HTTP header.HealthcareService identified in the 'if-match' HTTP header.HealthcareService identified in the 'if-match' HTTP header.HealthcareService identified in the 'if-match' HTTP header.PractitionerRole`` resources that reference this HealthcareService```.PractitionerRole`` resources that reference this HealthcareService```.PCA Healthcare Service resources for the same PCA Location.If the 'if-match' HTTP header is not provided in the request, then the PCA Publisher Agent will reject the request and return the error code 400.
\nIf the 'if-match' HTTP header does not match the current version, then the PCA Publisher Agent will reject the request and return the error code 412.
\nHTTP interaction signature:
\nPUT [publisher agent base url]/HealthcareService/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]if-match [version id] where [version id] is the version of the HealthcareService being updated.Request Body:
\nHealthcareService resource that conforms to the PCA Healthcare Service profile.
Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the HealthcareService resource returned.Response Body:
\nHealthcareService resource that conforms to the PCA Healthcare Service profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Location/[id]:PCA:Hsm HealthcareService/[id]:PCA:Hsm Organization/[id]:PS_ServiceMgr Location/[id]:PS_ServiceMgr HealthcareService/[id]:PS_ServiceMgrIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by providedBy in the target HealthcareService being updated.
If a scoped role identifies a Location then [id] SHALL identify the Location referenced by location in the target HealthcareService being updated.
If a scoped role identifies a HealthcareService then [id] SHALL identify the target HealthcareService being updated.
Response Codes:
\nsearch-typeDefinition:
\nThis operation is a RESTful search interaction (as described in the FHIR specification) for HealthcareService resources that conform to the PCA Partner Service profile.
Behaviour:
\nThe operation is used to find HealthcareService resources that that conform to the PCA Partner Service profile and that match the search parameters.
\nNote that all PCA Partner Service resources in the PCA service are accessible to all authorised client systems.
HTTP interaction signature:
\nGET [publisher agent base url]/HealthcareService/{?[parameters]}Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nHealthcareService resources that conform to the PCA Partner Service profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Location/[id]:PCA:Hsm HealthcareService/[id]:PCA:Hsm Organization/[id]:PS_Read Location/[id]:PS_Read HealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the publishing organisation associated with the target PCA Publisher Agent.
If a scoped role identifies a Location then [id] SHALL identify any existing Location within the scope of the requesting system.
If a scoped role identifies a HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.
Response Codes:
\nThis section defines the supported interactions for the PCA Healthcare Service profile and the PCA Partner Service profile of the
\nHealthcareServiceresource type.A
\nHealthcareServiceresource conforming to the PCA Healthcare Service profile describes a healthcare service offered at a location by a PCA publisher.A
\nHealthcareServiceresource conforming to the PCA Partner Service profile describes a partner service offered by a subscriber to which PCA publishers can publish their service offerings.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _profile | uri | |
| SHALL | active | token | |
| SHALL | organization | reference | |
| SHALL | service-catgeory | token | |
| SHALL | coverage-area.location.address-postalcode | string |
createDefinition:
\nThis operation is a RESTful create interaction (as described in the FHIR specification) of a PractitionerRole resource conforming to the PCA Practitioner Role profile.
Behaviour:
\nIf the Organization associated with the target PCA Publisher Agent has not been approved to participate in the PCA service, then the request will be rejected and the error code 422 will be returned.
If any of the following data validation rules are violated in the input resource, then the request is rejected and the error code 422 is returned:
\nHealthcareService that exists within the target PCA Publisher Agent.Practitioner that exists within the PCA service.Organization associated with the target PCA Publisher Agent SHALL have authorised the Agency as a Contracted Service Provider (CSP).HealthcareService referenced by the healthcareService element.HealthcareService referenced by the healthcareService element.Note: While the referenced Practitioner resource is managed via the PCA portal, it is also instantiated as a read-only 'proxy' within the PCA Publisher Agent. This means that the reference to Practitioner contained in the PractitionerRole is a local reference that is resolved within the PCA Publisher Agent. This 'proxy' has the same id as the resource within the PCA Portal for which it is a proxy.
HTTP interaction signature:
\nPOST [publisher agent base url]/PractitionerRoleMandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nPractitionerRole resource that conforms to the PCA Practitioner Role profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the new PractitionerRole resource.Response Body:
\nPractitionerRole resource that conforms to the PCA Practitioner Role profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\n Organization/[id]:PCA:Om Organization/[id]:PCA:Hsm Location/[id]:PCA:Hsm HealthcareService/[id]:PCA:Hsm Organization/[id]:PS_ServicesMgr Location/[id]:PS_ServicesMgr HealthcareService/[id]:PS_ServicesMgrIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by providedBy of the HealthcareService referenced by healthcareService in the new PractitionerRole.
if a scoped role identifies a Location then [id] SHALL identify the Location referenced by location of the HealthcareService referenced by healthcareService in the new PractitionerRole.
if a scoped role identifies a HealthcareService then [id] SHALL identify the HealthcareService referenced by healthcareService in the new PractitionerRole.
Response Codes:
\nreadDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a PractitionerRole resource.
Behaviour:
\nThis operation retrieves an identified PractitionerRole resource that conforms to the PCA Practitioner Role profile.
HTTP interaction signature:
\nGET [publisher agent base url]/PractitionerRole/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the PractitionerRole resource returned.Response Body:
\nPractitionerRole resource that conforms to the PCA Practitioner Role profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by providedBy in the HealthcareService referenced by healthcareService in the target PractitionerRole being read.
If a scoped role identifies a Location then [id] SHALL identify the Location referenced by location in the HealthcareService referenced by healthcareService in the target PractitionerRole being read.
If a scoped role identifies a HealthcareService then [id] SHALL identify the HealthcareService referenced by healthcareService in the target PractitionerRole being read.
Response Codes:
\nupdateDefinition:
\nThis operation is a RESTful update interaction (as described in the FHIR specification) of a PractitionerRole resource.
Behaviour:
\nIf the Organization associated with the target PCA Publisher Agent has not been approved to participate in the PCA service, then the request will be rejected and the error code 422 will be returned.
If any of the following data validation rules are violated in the input resource then the request is rejected and the error code 422 is returned:
\nPractitionerRole identified in the 'if-match' HTTP header.PractitionerRole identified in the 'if-match' HTTP header.PractitionerRole identified in the 'if-match' HTTP header.PractitionerRole identified in the 'if-match' HTTP header.PractitionerRole identified in the 'if-match' HTTP header.PractitionerRole identified in the 'if-match' HTTP header.HealthcareService referenced by the healthcareService element.HealthcareService referenced by the healthcareService element.If the 'if-match' HTTP header is not provided in the request, then the PCA Publisher Agent will reject the request and return the error code 400.
\nIf the 'if-match' HTTP header does not match the current version, then the PCA Publisher Agent will reject the request and return the error code 412.
\nHTTP interaction signature:
\nPUT [publisher agent base url]/PractitionerRole/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]if-match [version id] where [version id] is the version of the PractitionerRole being updated.Request Body:
\nPractitionerRole resource that conforms to the PCA Practtiioner Role profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the PractitionerRole resource returned.Response Body:
\nPractitionerRole resource that conforms to the PCA Practitioner Role profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_PractitionerMgrLocation/[id]:PS_PractitionerMgrHealthcareService/[id]:PS_PractitionerMgrIf a scoped role identifies an Organization then [id] SHALL identify the Organization referenced by providedBy in the HealthcareService referenced by healthcareService in the target PractitionerRole being updated.
If a scoped role identifies a Location then [id] SHALL identify the Location referenced by location in the HealthcareService referenced by healthcareService in the target PractitionerRole being updated.
If a scoped role identifies a HealthcareService then [id] SHALL identify the HealthcareService referenced by healthcareService in the target PractitionerRole being updated.
Response Codes:
\nThis section defines the supported interactions for the PCA Practitioner Role profile of the
\nPractitionerRoleresource type.Each
\nPractitionerRoleresource conforming to the PCA Practitioner Role profile describes a practitioner in a role at a healthcare service.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _lastUpdated | date | |
| SHALL | _id | token | |
| SHALL | active | token | |
| SHALL | identifier | token | |
| SHALL | organization | reference | |
| SHALL | practitioner | reference | |
| SHALL | service | reference |
readDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a Practitioner resource.
Behaviour:
\nThis operation retrieves an identified Practitioner resource that conforms to the PCA Practitioner profile.
The PCA Publisher Agent will include a identifier:hpii in the Practitioner resource returned if all of the following conditions are met:
Organization on whose behalf the request is made is a publisher organisation.Organization on whose behalf the request is made has been approved to participate in the PCA service.Organization on whose behalf the request is made has authorised the Agency as a Contracted Service Provider (CSP).Practitioner resource returned and where coding:hiServiceRole has the value 'ProvidesHealthcareToIndividuals'.HTTP interaction signature:
\nGET [publisher agent base url]/Practitioner/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the Practitioner resource returned.Response Body:
\nPractitioner resource that conforms to the PCA Practitioner profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the publishing organisation associated with the requesting system.
If a scoped role identifies a Location then [id] SHALL identify any existing Location within the scope of the requesting system.
If a scoped role identifies a HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.
Response Codes:
\nsearch-typeDefinition:
\nThis operation is a RESTful search interaction (as described in the FHIR specification) for a Practitioner resource for either a given Ahpra registration number or HPI-I identifier that conforms to the PCA Practitioner profile.
Behaviour:
\nThe operation is used to find a Practitioner resource given their Ahpra registration number or HPI-I identifier. The PCA Publisher Agent will return zero or one Practitioner resource that conforms to the PCA Practitioner profile.
The operation is only available to client systems acting on behalf of publisher organisations (see ‘Required OAuth 2.0 scopes’ below).
\nThe PCA Publisher Agent will reject requests and return the error code 403 if the identifier query string is not present, or if the identifier query string does not qualify the identifier value with one of the following systems:
\nThe PCA Publisher Agent return a Bundle containing exactly one Practitioner resource if the identifier query string matches the same record in either the Ahpra Register of practitioners or the HI Service, else it will return a Bundle contanining zero results.
The PCA Publisher Agent will only support searching by HPI-I if the client system’s organisation has has made the PCA a Contracted Service Provider (CSP).
\nThe PCA Publisher Agent will include the identifier:hpii element in the Practitioner resource returned if the client system’s organisation has has made the PCA a Contracted Service Provider (CSP) and the Practitioner resource's coding:hiServiceRole element has the value ‘ProvidesHealthcareToIndividuals’.
HTTP interaction signature:
\nGET [publisher agent base url]/Practitioner/{?[parameter]}Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nPractitioner resources that conforms to the PCA Practitioner profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ServicesMgrLocation/[id]:PS_ServicesMgrHealthcareService/[id]:PS_ServicesMgrIf a scoped role identifies an Organization then [id] SHALL identify the publishing organisation associated with the requesting system.
If a scoped role identifies a Location then [id] SHALL identify any existing Location within the scope of the requesting system.
If a scoped role identifies a HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.
Response Codes:
\nThis section defines the supported interactions for the PCA Practitioner profile of the
\nPractitionerresource type.Each
\nPractitionerresource conforming the PCA Practitioner profile is a read-only proxy for a correspondingPractitionerresource managed by the PCA portal.Each 'proxy' has the same id and versionId as the resource within the PCA portal for which it is a proxy.
\n
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token |
readDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a Provenance resource.
Behaviour:
\nThis operation retrieves an identified Provenance resource that conforms to the PCA Provenance profile.
HTTP interaction signature:
\nGET [publisher agent base url]/Provenance/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nProvenance resource that conforms to the PCA Provenance profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf the Provenance resource being read has a target that references an Organization, then:
Organization then [id] SHALL identify the Organization referenced by target in the Provenance resource being read.If the Provenance resource being read has a target that references a Practitioner, then:
Organization then [id] SHALL identify the publishing organisation associated with the requesting system.Location then [id] SHALL identify any existing Location within the scope of the requesting system.HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.Response Codes:
\nThis section defines the supported interactions for the PCA Provenance profile of the
\nProvenanceresource type.Each
\nProvenanceresource conforming to the PCA Provenance profile represents an activity performed by the PCA service (conditionally on behalf of a participating organisation when the target element references a PCA Organization resource) whereby specific data elements of a PCA Organization or PCA Practitioner resource have been initially retrieved, updated or verified from an external system of record.
createDefinition:
\nThis operation is a RESTful create interaction (as described in the FHIR specification) of a Contract resource conforming to the PCA Publication Authorisation Record profile.
Please note: This operation will be available in Release 2.1 of PCA.
\nBehaviour:
\nThis operation records a decision made by an authorised representative of a publisher organisation to authorise the publication of a HealthcareService or PractitionerRole to a partner service.
Authorisation is implemented using this operation. Revocation is implemented by updating the status of the existing Contract to 'revoked'.
A Contract resource cannot be created with a status of 'cancelled' - this status can only by set by the PCA service and is used to indicate that the partner service associated with the publication authorisation is inactive.
If the invocation of a Contract resource with status of 'executed' is sucessful then the PCA service will make the following resources available to the PCA Subscriber Agent of the organisation referenced by providedBy of the partner service:
HealthcareService or PractitionerRole).Organization, Location and Practitioner resources that are referenced directly or indirectly by the target HealthcareService or PractitionerRole.Contract resource.The PCA service will also continue to make available any new versions of these resources to the same PCA Subscriber Agent. This process continues until the existing Contract resource is updated with a status of 'revoked'.
Prior to invoking this operation the following PCA API operations are available to provide the information that is recorded in the Contract resource to be created.
Contract resource) from the pca-current-information-use-statement extension in the partner service resourceIf any of the following data validation rules are violated in the input resource, then the request is rejected and the error code 422 is returned:
\nHealthcareService or PractitionerRole implemented by the PCA Publisher Agent (i.e. the target FHIR server)Contract resource) whose legal.content[x].data element was viewed by the person responsible for making the publication decision recorded via the new Contract resource.HTTP interaction signature:
\nPOST [publisher agent base url]/ContractMandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nContract resource that conforms to the PCA Publication Authorisation Record profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nContract resource that conforms to the PCA Publication Authorisation Record profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_PublicationMgrLocation/[id]:PS_PublicationMgrHealthcareService/[id]:PS_PublicationMgrIf a scoped role identifies an Organization then:
Contract being created references a HealthcareService then [id] SHALL identify the Organization referenced by providedBy in that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the Organization referenced by providedBy in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a Location then:
Contract being created references a HealthcareService then [id] SHALL identify the Location referenced by location in that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the Location referenced by location in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a HealthcareService then:
Contract being created references a HealthcareService then [id] SHALL identify that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the HealthcareService referenced by healthcareService in that PractitionerRole.Response Codes:
\nreadDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a Contract resource.
Please note: This operation will be available in Release 2.1 of PCA.
\nBehaviour:
\nThis operation is used to retrieve an identified Contract resource that conforms to one of the following profiles:
HTTP interaction signature:
\nGET [publisher agent base url]/Contract/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nContract resource that conforms to the PCA Publication Authorisation Record profile or the PCA Information Use Statement profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadWhen retrieving a Contract resource that conforms to the PCA Publication Authorisation Record profile:
If a scoped role identifies an Organization then:
Contract being read references a HealthcareService then [id] SHALL identify the Organization referenced by providedBy in that HealthcareService.Contract being read references a PractitionerRole then [id] SHALL identify the Organization referenced by providedBy in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a Location then:
Contract being read references a HealthcareService then [id] SHALL identify the Location referenced by location in that HealthcareService.Contract being read references a PractitionerRole then [id] SHALL identify the Location referenced by location in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a HealthcareService then:
Contract being read references a HealthcareService then [id] SHALL identify that HealthcareService.Contract being read references a PractitionerRole then [id] SHALL identify the HealthcareService referenced by healthcareService in that PractitionerRole.When retrieving a Contract resource that conforms to the PCA Information Use Statement profile:
Organization then [id] SHALL identify the publishing organisation associated with the target PCA Publisher Agent.Location then [id] SHALL identify any existing Location within the scope of the requesting system.HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requestingResponse Codes:
\nupdateDefinition:
\nThis operation is a RESTful update interaction (as described in the FHIR specification) of a Contract resource.
Please note: This operation will be available in Release 2.1 of PCA.
\nBehaviour:
\nThis operation can be used to record a decision made by an authorised representative of a publisher organisation to revoke an existing authorisation to publish, or to record that a new version of a partner service's information use statement has been accepted:
\nContract resource to 'revoked'.Contract resource to reference a new information use statement.To re-authorise publication after revoking, create a new Contract resource.
If any of the following data validation rules are violated in the input resource, then the request is rejected and the error code 422 is returned:
\nContract identified in the 'if-match' HTTP header.Contract identified in the 'if-match' HTTP header.Contract identified in the 'if-match' HTTP header.Contract identified in the 'if-match' HTTP header has a status of 'executed', and status is not also being updated.Contract identified in the 'if-match' HTTP header.If the 'if-match' HTTP header is not provided in the request, then the PCA Publisher Agent will reject the request and return the error code 400.
\nIf the 'if-match' HTTP header does not match the current version, then the PCA Publisher Agent will reject the request and return the error code 412.
\nHTTP interaction signature:
\nPUT [publisher agent base url]/ContractMandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Authorization: Bearer [token]if-match [version id] where [version id] is the version of the Contract being updated.Request Body:
\nContract resource that conforms to the PCA Publication Authorisation Record profile.Mandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8ETag: [version id] where [version id] identifies the version of the Contract resource returned.Response Body:
\nContract resource that conforms to the PCA Publication Authorisation Record profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_PublicationMgrLocation/[id]:PS_PublicationMgrHealthcareService/[id]:PS_PublicationMgrIf a scoped role identifies an Organization then:
Contract being created references a HealthcareService then [id] SHALL identify the Organization referenced by providedBy in that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the Organization referenced by providedBy in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a Location then:
Contract being created references a HealthcareService then [id] SHALL identify the Location referenced by location in that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the Location referenced by location in the HealthcareService referenced by healthcareService in that PractitionerRole.If a scoped role identifies a HealthcareService then:
Contract being created references a HealthcareService then [id] SHALL identify that HealthcareService.Contract being created references a PractitionerRole then [id] SHALL identify the HealthcareService referenced by healthcareService in that PractitionerRole.Response Codes:
\nsearch-typeDefinition:
\nThis operation is a RESTful search interaction (as described in the FHIR specification) for Contract resources.
Behaviour:
\nThis operation is used to find Contract resources that conform to the PCA Information Use Statement profile and that match the search parameters.
Note that all PCA Information Use Statement resources in the PCA service are accessible to all authorised client systems.
\nHTTP interaction signature:
\nGET [publisher agent base url]/Contract/{?[parameters]}Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nBundle containing zero to many Contract resources that conform to the PCA Information Use Statement profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then [id] SHALL identify the publishing organisation associated with the target PCA Publisher Agent.
If a scoped role identifies a Location then [id] SHALL identify any existing Location within the scope of the requesting system.
If a scoped role identifies a HealthcareService then [id] SHALL identify any existing HealthcareService within the scope of the requesting system.
Response Codes:
\nThis section defines the supported interactions for the PCA Publication Authorisation Record profile and the PCA Information Use Statement profile of the
\nContractresource type.A
\nContractresource conforming to the PCA Publication Authorisation Record profile records a decision regarding the publication of a specific service offering (either aHealthcareServiceor aPractitionerRole) to a specific partner service. The decision is either to authorise publication or to revoke a previous authority to publish.A
\nContractresource conforming to the PCA Information Use Statement profile represents a policy statement by a subscriber organisation's partner service that describes how they will use the information from publisher organisations that is disclosed to the partner service.
readDefinition:
\nThis operation is a RESTful read interaction (as described in the FHIR specification) of a Task resource.
Behaviour:
\nThis operation retrieves an identified Task resource that conforms to the PCA Match Record profile.
HTTP interaction signature:
\nGET [publisher agent base url]/Task/[id]Mandatory Request Headers:
\nAccept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8Authorization: Bearer [token]Request Body:
\nMandatory Response Headers:
\nContent-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8Response Body:
\nTask resource that conforms to the PCA Match Record profile.OperationOutcome resource (see FHIR specification).Required OAuth 2.0 scopes:
\nThe scope string SHALL contain one or more of the following scoped roles:
\nOrganization/[id]:PCA:OmOrganization/[id]:PCA:HsmLocation/[id]:PCA:HsmHealthcareService/[id]:PCA:HsmOrganization/[id]:PS_ReadLocation/[id]:PS_ReadHealthcareService/[id]:PS_ReadIf a scoped role identifies an Organization then:
Task being read references an Organization, then [id] SHALL identify that Organization.Task being read references a Location, then [id] SHALL identify the Organization referenced by managingOrganization of the Location.Task being read references a HealthcareService, then [id] SHALL identify the Organization referenced by providedBy of that HealthcareService.Task being read references a PractitionerRole, then [id] SHALL identify the Organization referenced by providedBy of the HealthcareService referenced by healthcareService of that PractitionerRole.If a scoped role identifies a Location then:
Task being read references a Location, then [id] SHALL identify that Location.Task being read references a HealthcareService, then [id] SHALL identify the Location referenced by location of that HealthcareService.Task being read references a PractitionerRole, then [id] SHALL identify the Location referenced by location of the HealthcareService referenced by healthcareService of that PractitionerRole.If a scoped role identifies a HealthcareService then:
Task being read references a HealthcareService, then [id] SHALL identify that HealthcareService.Task being read references a PractitionerRole, then [id] SHALL identify the HealthcareService referenced by healthcareService of that PractitionerRole.Response Codes:
\nThis section defines the supported interactions for the PCA Match Record profile of the
\nTaskresource type.A
\nTaskresource conforming to the PCA Match Record profile indicates the matching status of a service offering to a partner service’s local data store.