Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of an Organization resource.

Behaviour:

This operation retrieves an identified Organization resource that conforms to the PCA Organization profile. As described in the common behaviour section, the Organization resource excludes any Identifiers that cannot be disclosed to the subscriber.

HTTP interaction signature:

• GET [subscriber agent base url]/Organization/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Organization resource returned.

Response Body:

• Success: Organization resource that conforms to the PCA Organization profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful patch interaction (as described in the FHIR specification) of an Organization resource.

Behaviour:

This operation is used to update an identified Organization resource that conforms to the PCA Organization profile via a JSON or XML patch document. This operation will only process a patch operation for adding or updating an identifier element.

If any of the following data validation rules are violated, then the request is rejected and the error code 422 is returned:

• The patch document SHALL only contain an operation for adding or updating an identifier element.
• Only one identifier element per identifier.system SHALL be allowed for the identified Organization resource.
• The patch operation SHALL only add or update an identifier element where identifier.system identifies a subscriber identifier system that is owned by the participating organisation associated with the target PCA Subscriber Agent.
• The patch operation SHALL only add or update an identifier element where a PCA Match Record exists within the PCA service with:
  • A status of 'completed', and;
  • A focus referencing the Organization resource, and;
  • An owner referencing a PCA Partner Service of the participating organisation associated with the target PCA Subscriber Agent.

HTTP interaction signature:

• PATCH [subscriber agent base url]/Organization/[id]

Mandatory Request Headers:

• Accept: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Content-Type: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• A JSON Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc6902 with a content type of application/json-patch+json, or;
• An XML Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc5261 with a content type of application/xml-patch+xml

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Organization resource returned.

Response Body:

• Success: Organization resource that conforms to the PCA Organization profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.
• Code 422: The input patch document violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a Location resource.

Behaviour:

This operation retrieves an identified Location resource that conforms to the PCA Location profile. As described in the common behaviour section, the Location resource excludes any Identifiers that cannot be disclosed to the subscriber.

HTTP interaction signature:

• GET [subscriber agent base url]/Location/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Location resource returned.

Response Body:

• Success: Location resource that conforms to the PCA Location profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful patch interaction (as described in the FHIR specification) of a Location resource.

Behaviour:

This operation is used to update an identified Location resource that conforms to the PCA Location profile via a JSON or XML patch document. This operation will only process a patch operation for adding or updating an identifier element.

If any of the following data validation rules are violated, then the request is rejected and the error code 422 is returned:

• The patch document SHALL only contain an operation for adding or updating an identifier element.
• Only one identifier element per identifier.system SHALL be allowed for the identified Location resource.
• The patch operation SHALL only add or update an identifier element where identifier.system identifies a subscriber identifier system that is owned by the participating organisation associated with the target PCA Subscriber Agent.
• The patch operation SHALL only add or update an identifier element where a PCA Match Record exists within the PCA service with:
  • A status of 'completed', and;
  • A focus referencing the Location resource, and;
  • An owner referencing a PCA Partner Service of the participating organisation associated with the target PCA Subscriber Agent.

HTTP interaction signature:

• PATCH [subscriber agent base url]/Location/[id]

Mandatory Request Headers:

• Accept: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Content-Type: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• A JSON Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc6902 with a content type of application/json-patch+json, or;
• An XML Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc5261 with a content type of application/xml-patch+xml

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Location resource returned.

Response Body:

• Success: Location resource that conforms to the PCA Location profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.
• Code 422: The input patch document violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a HealthcareService resource.

Behaviour:

This operation is used to retrieve an identified HealthcareService resource that conforms to one of the following profiles:

• PCA Healthcare Service
• PCA Partner Service

As described above a HealthcareService resource conforming to the PCA Healthcare Service profile excludes any Identifiers that cannot be disclosed to the subscriber.

HTTP interaction signature:

• GET [subscriber agent base url]/HealthcareService/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the HealthcareService resource returned.

Response Body:

• Success: HealthcareService resource that conforms to the PCA Healthcare Service profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful patch interaction (as described in the FHIR specification) of a HealthcareService resource.

Behaviour:

This operation is used to update an identified HealthcareService resource that conforms to the PCA Healthcare Service profile via a JSON or XML patch document. This operation will only process a patch operation for adding or updating an identifier element.

If any of the following data validation rules are violated, then the request is rejected and the error code 422 is returned:

• The patch document SHALL only contain an operation for adding or updating an identifier element.
• Only one identifier element per identifier.system SHALL be allowed for the identified HealthcareService resource.
• The patch operation SHALL only add or update an identifier element where identifier.system identifies a subscriber identifier system that is owned by the participating organisation associated with the target PCA Subscriber Agent.
• The patch operation SHALL only add or update an identifier element where a PCA Match Record exists within the PCA service with:
  • A status of 'completed', and;
  • A focus referencing the HealthcareService resource, and;
  • An owner referencing a PCA Partner Service of the participating organisation associated with the target PCA Subscriber Agent.

HTTP interaction signature:

• PATCH [subscriber agent base url]/HealthcareService/[id]

Mandatory Request Headers:

• Accept: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Content-Type: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• A JSON Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc6902 with a content type of application/json-patch+json, or;
• An XML Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc5261 with a content type of application/xml-patch+xml

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the HealthcareService resource returned.

Response Body:

• Success: HealthcareService resource that conforms to the PCA Healthcare Service profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.
• Code 422: The input patch document violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful search interaction (as described in the FHIR specification) for HealthcareService resources that conform to the PCA Partner Service profile.

Behaviour:

The operation is used to find HealthcareService resources that that conform to the profile PCA Partner Service profile and that match the search parameters.
Note that all PCA Partner Service resources in the PCA service are accessible to all authorised client systems.

HTTP interaction signature:

• GET [subscriber agent base url]/HealthcareService/{?[parameters]}

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Bundle that contains zero to many HealthcareService resources that conform to the PCA Partner Service profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: Search successfully performed (but may return zero matching results).
• Code 403: Server refused to perform the search.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a PractitionerRole resource.

Behaviour:

This operation retrieves an identified PractitionerRole resource that conforms to the PCA Practitioner Role profile. As described in the common behaviour section, the PractitionerRole resource excludes any Identifiers that cannot be disclosed to the subscriber.

HTTP interaction signature:

• GET [subscriber agent base url]/PractitionerRole/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the PractitionerRole resource returned.

Response Body:

• Success: PractitionerRole resource that conforms to the PCA Practitioner Role profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful patch interaction (as described in the FHIR specification) of a PractitionerRole resource.

Behaviour:

This operation is used to update an identified PractitionerRole resource that conforms to the PCA Practitioner Role profile via a JSON or XML patch document. This operation will only process a patch operation for adding or updating an identifier element.

If any of the following data validation rules are violated, then the request is rejected and the error code 422 is returned:

• The patch document SHALL only contain an operation for adding or updating an identifier element.
• Only one identifier element per identifier.system SHALL be allowed for the identified PractitionerRole resource.
• The patch operation SHALL only add or update an identifier element where identifier.system identifies a subscriber identifier system that is owned by the participating organisation associated with the target PCA Subscriber Agent.
• The patch operation SHALL only add or update an identifier element where a PCA Match Record exists within the PCA service with:
  • A status of 'completed', and;
  • A focus referencing the PractitionerRole resource, and;
  • An owner referencing a PCA Partner Service of the participating organisation associated with the target PCA Subscriber Agent.

HTTP interaction signature:

• PATCH [subscriber agent base url]/PractitionerRole/[id]

Mandatory Request Headers:

• Accept: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Content-Type: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• A JSON Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc6902 with a content type of application/json-patch+json, or;
• An XML Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc5261 with a content type of application/xml-patch+xml

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the PractitionerRole resource returned.

Response Body:

• Success: PractitionerRole resource that conforms to the PCA Practitioner Role profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.
• Code 422: The input patch document violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a Practitioner resource.

Behaviour:

This operation retrieves an identified Practitioner resource that conforms to the PCA Practitioner profile. As described in the common behaviour section, the Practitioner resource excludes any Identifiers that cannot be disclosed to the subscriber.

HTTP interaction signature:

• GET [subscriber agent base url]/Practitioner/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Practitioner resource returned.

Response Body:

• Success: Practitioner resource that conforms to the PCA Practitioner profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a Provenance resource.

Behaviour:

This operation retrieves an identified Provenance resource that conforms to the PCA Provenance profile.

HTTP interaction signature:

• GET [subscriber agent base url]/Provenance/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Provenance resource that conforms to the PCA Provenance profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a Contract resource.

This operation is used to retrieve an identified Contract resource that conforms to one of the following profiles:

• PCA Publication Authorisation Record
• PCA Information Use Statement

Different authorisation rules apply depending on the profile of the Contract resource being retrieved; see the 'Required OAuth 2.0 scopes' section

HTTP interaction signature:

• GET [subscriber agent base url]/Contract/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Contract resource that conforms to the PCA Publication Authorisation Record profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful search interaction (as described in the FHIR specification) for Contract resources.

Behaviour:

This 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.

HTTP interaction signature:

• GET [subscriber agent base url]/Contract/{?[parameters]}

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Bundle containing zero to many Contract resources that conform to the profile PCA Information Use Statement profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: Search successfully performed (but may return zero matching results).
• Code 403: Server refused to perform the search.

Definition:

This operation is a RESTful read interaction (as described in the FHIR specification) of a Task resource.

Behaviour:

This operation retrieves an identified Task resource that conforms to the PCA Match Record profile or the PCA Partner Service profile of the Task resource type.

HTTP interaction signature:

• GET [subscriber agent base url]/Task/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Task resource that conforms to the PCA Match Record profile or the PCA Partner Service Task profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain one of the following scoped role:

• Organization/[id]:SS_Receiver
• Organization/[id]:SS_TaskManager

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.
The SS_Updater role SHALL be used for reading Taskresources conforming to the PCA Match Record profile.
The SS_TaskManager role SHALL be used for reading Taskresources conforming to the PCA Partner Service Task profile.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.

Definition:

This operation is a RESTful create interaction (as described in the FHIR specification) of a Task resource that conforms to the PCA Match Record profile or the PCA Partner Service Task profile.

Behaviour:

If any of the applicable data validation rules are violated in the input resource then the request is rejected and the error code 422 is returned.

Common validation rules:

• The resource SHALL conform to the PCA Match Record profile or the or the PCA Partner Service profile.
• id SHALL NOT be present.
• meta.versionId SHALL NOT be present.
• meta.lastUpdated SHALL NOT be present.
• focus SHALL reference a resource that has been published to one or more Partner Services associated with the target PCA Subscriber Agent.

PCA Match Record validation rules:

• If the resource conforms to the PCA Match Record profile:
  • note.text SHALL be a maximum of 200 characters.
  • owner SHALL reference a Partner Service associated with the target PCA Subscriber Agent.

PCA Partner Service Task validation rules:

• If the resource conforms to the PCA Partner Service Task profile:

  • for SHALL reference a Partner Service associated with the target PCA Subscriber Agent.

• If the resource conforms to the PCA Partner Service Task profile and the type is 'PartnerServiceCompleteOnlineForm':

  • focus SHALL reference either a PCA Healthcare Service or PCA Practitioner Role resource.
  • The resource SHALL contain input elements for each of the following task parameters:
    • type = 'dueOn', value = valueDateTime
    • type = 'reason', value = valueString
    • type = 'urlId', value = valueString
    • type = 'formName', value = valueString
  • The 'urlId' task paramater SHALL match one of the partner service website records (configured in PCA) of the Partner Service identified by owner.
  • The partner service website record identified by the 'urlId' task paramater SHALL have a context of use (e.g. Healthcare Service context or Practitioner Role context) that aligns with the resource type referenced in the focus element.

• If the resource conforms to the PCA Partner Service Task profile and the type is 'PartnerServiceProvideMissingInformation':
  • The resource SHALL contain an input element for the following task parameter:
    • type = 'missingDetails', value = valueString
  • If focus references a PCA Organization resource, the 'missingDetails' task parameter SHALL contain a comma-separated string containing one or more of the following property names:
    • Fax
    • Website
    • PostalAddress
  • If focus references a PCA Location resource, the 'missingDetails' task parameter SHALL contain a comma-separated string containing one or more of the following property names:
    • Phone
    • Email
    • Fax
    • Website
    • PostalAddress
  • If focus references a PCA Healthcare Service resource, the 'missingDetails' task parameter SHALL contain a comma-separated string containing one or more of the following property names:
    • Phone
    • Email
    • Fax
    • AfterHoursPhone
    • Website
    • PostalAddress
  • If focus references a PCA Practitioner Role resource, the 'missingDetails' task parameter SHALL contain a comma-separated string containing one or more of the following property names:
    • PreferredNameAtLocation
    • NumberOfDays
    • HpiiIdentifier
    • MedicareProviderNumber

• If the resource conforms to the PCA Partner Service Task profile and the type is 'PartnerServiceVerifyInformation':
  • The resource SHALL contain one input element for the following task parameter:
    • type = 'verifyDetails', value = valueString
  • The input element SHALL use the PCA Property Name extension to identify the property name:
    • If focus references a PCA Organization resource, the extension SHALL use one of the following property names:
      • Fax
      • Website
    • If focus references a PCA Location resource, the extension SHALL use one of the following property names:
      • Phone
      • Email
      • Fax
      • Website
    • If focus references a PCA Healthcare Service resource, the extension SHALL use one of the following property names:
      • Phone
      • Email
      • Fax
      • AfterHoursPhone
      • Website
    • If focus references a PCA Practitioner Role resource, the extension SHALL use one of the following property names:
      • PreferredNameAtLocation
      • NumberOfDays
  • The input element SHALL use valueString to record a new suggested value of the property, if the Partner Service chooses to suggest a new value.

HTTP interaction signature:

• POST [subscriber agent base url]/Task

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• Task resource that conforms to the PCA Match Record profile.

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the new Task resource.

Response Body:

• Success: Task resource that conforms to the PCA Match Record profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater
• Organization/[id]:SS_TaskManager

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.
The SS_Updater role SHALL be used for creating Task resources conforming to the PCA Match Record profile.
The SS_TaskManager role SHALL be used for creating Task resources conforming to the PCA Partner Service Task profile.

Response Codes:

• Code 201: The resource was successfully created.
• Code 400: The input resource could not be parsed or failed basic FHIR validation rules.
• Code 404: The resource type is not supported, or not a FHIR end-point.
• Code 422: The input resource violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful update interaction (as described in the FHIR specification) of a Task resource that conforms to the PCA Match Record profile or the PCA Partner Service Task profile.

Behaviour:

If the 'if-match' HTTP header is not provided in the request, then the PCA Subscriber Agent will reject the request and return the error code 400.

If the 'if-match' HTTP header does not match the current version, then the PCA Subscriber Agent will reject the request and return the error code 412.

If any of the applicable data validation rules are violated in the input resource then the request is rejected and the error code 422 is returned.

Common validation rules:

• The resource SHALL conform to the PCA Match Record profile or the or the PCA Partner Service Task profile.
• id SHALL be identical to the corresponding value in the version of the Task identified in the 'if-match' HTTP header.
• meta.versionId SHALL NOT be present.
• meta.lastUpdated SHALL NOT be present.

PCA Match Record validation rules:

• If the resource conforms to the PCA Match Record profile:
  • owner SHALL reference a Partner Service associated with the target PCA Subscriber Agent.
  • Only changes to status (and optionally note.text) will be accepted; changes to any other element values will not be accepted when updating an existing Task.
  • note.text SHALL only be updated if status is being changed from 'completed' to 'failed'.
  • note.text SHALL be a maximum of 200 characters.

PCA Partner Service Task validation rules:

• If the resource conforms to the PCA Partner Service Task profile:
  • for SHALL reference a Partner Service associated with the target PCA Subscriber Agent.
  • type SHALL be 'PartnerServiceCompleteOnlineForm'.
  • Only a change to status from 'requested' to 'completed' will be accepted; changes to any other element values will not be accepted when updating an existing Task.

HTTP interaction signature:

• PUT [subscriber agent base url]/Task/[id]

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]
• if-match [version id] where [version id] is the version of the Task being updated.

Request Body:
Task resource that conforms to the PCA Match Record profile.

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Task resource returned.

Response Body:

• Success: Task resource that conforms to the PCA Match Record profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater
• Organization/[id]:SS_TaskManager

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.
The SS_Updater role SHALL be used for updating Task resources conforming to the PCA Match Record profile.
The SS_TaskManager role SHALL be used for updating Task resources conforming to the PCA Partner Service Task profile.

Response Codes:

• Code 200: The resource was found and returned.
• Code 400: Client error: request did not include the if-match HTTP header.
• Code 404: The resource was not found.
• Code 412: The version id given in the if-Match HTTP request header does not match the current version.
• Code 422: The input resource violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful patch interaction (as described in the FHIR specification) of a Task resource.

Behaviour:

This operation is used to update an identified Task resource that conforms to the PCA Match Record profile via a JSON or XML patch document. This operation will only process a patch operation for adding or updating an identifier element.

If any of the following data validation rules are violated, then the request is rejected and the error code 422 is returned:

• The patch document SHALL only contain an operation for adding or updating an identifier element.
• Only one identifier element per identifier.system SHALL be allowed for the identified Task resource.
• The patch operation SHALL only add or update an identifier element where identifier.system identifies a subscriber identifier system that is owned by the participating organisation associated with the target PCA Subscriber Agent.
• The patch operation SHALL only add or update an identifier element where a PCA Match Record exists within the PCA service with:
  • A status of 'completed', and;
  • A focus referencing the Task resource, and;
  • An owner referencing a PCA Partner Service of the participating organisation associated with the target PCA Subscriber Agent.

HTTP interaction signature:

• PATCH [subscriber agent base url]/Task/[id]

Mandatory Request Headers:

• Accept: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Content-Type: application/json-patch+json;charset=utf-8 or Accept: application/xml-patch+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• A JSON Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc6902 with a content type of application/json-patch+json, or;
• An XML Patch document that conforms to https://datatracker.ietf.org/doc/html/rfc5261 with a content type of application/xml-patch+xml

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• ETag: [version id] where [version id] identifies the version of the Task resource returned.

Response Body:

• Success: Task resource that conforms to the PCA Match Record profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Updater

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: The resource was found and returned.
• Code 404: The resource was not found.
• Code 422: The input patch document violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful search interaction (as described in the FHIR specification) for Task resources that conform to the PCA Match Record profile or the PCA Partner Service Task profile.

Behaviour:

The operation is used to find Task resources that that conform to the profile PCA Match Record profile or the PCA Partner Service Task profile and that match the search parameters.

HTTP interaction signature:

• GET [subscriber agent base url]/Task/{?[parameters]}

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Bundle that contains zero to many Task resources that conform to the PCA Match Record profile or the PCA Partner Service Task profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: Search successfully performed (but may return zero matching results).
• Code 403: Server refused to perform the search.

Definition:

This operation is a RESTful create interaction (as described in the FHIR specification) of a Subscription resource conforming to the PCA Subscription profile.

Behaviour:

This operation is used to register a callback to receive a notification whenever there are changes in the data set that is published to a subscriber.

A notification is simply a HTTP POST without any content – the purpose is to trigger the subscriber’s client system to get the available service offerings by invoking the whole system search operation.

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:

• status SHALL be 'requested'
• reason SHALL be 'subscriber change notifications'
• criteria SHALL be a space separated list of resource types from the list 'HealthcareService', 'PractitionerRole', 'Location', 'Organization', 'Practitioner', 'Provenance', 'Contract', 'Task'
• channel.type SHALL be 'rest-hook'
• channel.endpoint SHALL be the URL of an endpoint that is operated by (or on behalf of) the subscriber for receiving notifications. The protocol SHALL be https.
• channel.payload SHALL NOT be present – its absence indicates that the subscriber will not receive any resources via this endpoint.
• channel.header SHALL be set to 'Authorization: Bearer [secret string]' where [secret string] is the basic authentication string, set by the subscriber organisation, that is used to authenticate the PCA Subscriber Agent to the notification receiving endpoint.

HTTP interaction signature:

• POST [subscriber agent base url]/Subscription

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• Subscription resource that conforms to the PCA Subscription profile.

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Subcription resource that conforms to the PCA Subscription profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 201: The resource was successfully created.
• Code 400: The input resource could not be parsed or failed basic FHIR validation rules.
• Code 404: The resource type is not supported, or not a FHIR end-point.
• Code 422: The input resource violated applicable FHIR profiles or server data validation rules.

Definition:

This operation is a RESTful search interaction (as described in the FHIR specification) for a Subscription resource that is associated with the target Subscriber Agent and that conforms to the PCA Subscription profile.

Behaviour:

This operation is used to find a Subscription resource that is associated with the target Subscriber Agent and that conforms to the PCA Subscription profile.

HTTP interaction signature:

• GET [subscriber agent base url]/Subscription/

Mandatory Request Headers:

• Accept: application/fhir+json;charset=utf-8 or Accept: application/fhir+xml;charset=utf-8
• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• Content-Type: application/fhir+json;charset=utf-8 or Content-Type: application/fhir+xml;charset=utf-8

Response Body:

• Success: Bundle that contains zero or one Subscription resource that that is associated with the target Subscriber Agent and that conforms to the PCA Subscription profile.
• Error: OperationOutcome resource (see FHIR specification).

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 200: Search successfully performed (but may return zero matching results).
• Code 403: Server refused to perform the search.

Definition:

This operation is a RESTful delete interaction (as described in the FHIR specification) of a Subscription resource.

Behaviour:

This operation is used to deregister an existing notification callback.

HTTP interaction signature:

• DELETE [subscriber agent base url]/Subscription/[id]

Mandatory Request Headers:

• Authorization: Bearer [token]

Request Body:

• (No request body)

Mandatory Response Headers:

• (No request body)

Response Body:

• (No request body)

Required OAuth 2.0 scopes:

The scope string SHALL contain the following scoped role:

• Organization/[id]:SS_Receiver

Where [id] SHALL identify the Organization associated with the target PCA Subscriber Agent.

Response Codes:

• Code 202: The deletion was accepted.
• Code 404: The resource was not found.