pca-subscriber-agent
type: CapabilityStatement
node role: treeRoot
resource.id:
  value: pca-subscriber-agent
domain resource.text:
  narrative.status:
    value: extensions
  narrative.div: PCASubscriberAgentCapabilityStatement This is the Capability statement for a PCA Subscriber Agent FHIR server. Mode SERVER Description A PCA Subscriber Agent manages the service offerings for one subscriber organisation (also referred to as a 'business partner' in the PCA portal). The PCA service instantiates one PCA Subscriber Agent for each participating subscriber organisation. That is, each subscriber organisation interacts with a PCA Subscriber Agent located at a subscriber agent base url that is unique to that organisation. The subscriber agent base URL for a particular organisation is available via the PCA portal on the 'Organisation Details' screen of the subscriber organisation. A service offering is made available to a subscriber organisation when a publisher authorises publication of a resource to one or more of the subscriber organisation's partner services. Publication process A 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 The PCA service enforces certain business rules regarding the disclosure of Identifiers (including subscriber-issued identifiers) in the resources that it makes available to subscribers. The 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. In the case of HPI-Is these identifier disclosure rules ensure that relevant legal re…
capability statement.url:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/CapabilityStatement/pca-subscriber-agent
capability statement.version:
  value: 2.4.0
capability statement.name:
  value: PCASubscriberAgentCapabilityStatement
capability statement.title:
  value: PCA Subscriber Agent Capability Statement
capability statement.status:
  value: draft
capability statement.experimental:
  value: false
capability statement.date:
  value: 2023
capability statement.publisher:
  value: Australian Digital Health Agency
capability statement.contact:
  index: 0
  contact detail.telecom:
    index: 0
    contact point.system:
      value: email
capability statement.description:
  value: This is the Capability statement for a PCA Subscriber Agent FHIR server.
capability statement.copyright:
  value: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
capability statement.kind:
  value: requirements
capability statement.fhir version:
  value: 4.0.1
capability statement.format:
  value: application/fhir+json
  index: 0
capability statement.format:
  value: application/fhir+xml
  index: 1
capability statement.rest:
  index: 0
  capability statement.rest.mode:
    value: server
  capability statement.rest.documentation:
    value: A PCA Subscriber Agent manages the service offerings for one subscriber organisation (also referred to as a 'business partner' in the PCA portal). The PCA service instantiates one PCA Subscriber Agent for each participating subscriber organisation. That is, each subscriber organisation interacts with a PCA Subscriber Agent located at a *subscriber agent base url* that is unique to that organisation. The *subscriber agent base URL* for a particular organisation is available via the PCA portal on the 'Organisation Details' screen of the subscriber organisation. A service offering is made available to a subscriber organisation when a publisher authorises publication of a resource to one or more of the subscriber organisation's partner services. **Publication process** A 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](CapabilityStatement-pca-publisher-agent.html#contract)). **Identifier disclosure rules** The PCA service enforces certain business rules regarding the disclosure of *Identifiers* (including subscriber-issued identifiers) in the resources that it makes available to subscribers. The 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. In the case of HPI-Is these *identifier disclosure rules* ensure that relevant legal requirements a…
  capability statement.rest.security:
    capability statement.rest.security.cors:
      value: true
    capability statement.rest.security.service:
      index: 0
      codeable concept.coding:
        index: 0
    capability statement.rest.security.description:
      value: This server implements OAuth2
  capability statement.rest.resource:
    index: 0
    capability statement.rest.resource.type:
      value: Organization
    capability statement.rest.resource.profile:
      value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization
      link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization
    capability statement.rest.resource.documentation:
      value: This section defines the supported interactions for the [PCA Organization](StructureDefinition-pca-organization.html) profile of the ```Organization``` resource type.
    capability statement.rest.resource.interaction:
      index: 0
      capability statement.rest.resource.interaction.code:
        value: read
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of an ```Organization``` resource. **Behaviour**: This operation retrieves an identified ```Organization``` resource that conforms to the [PCA Organization](StructureDefinition-pca-organization.html) profile. As described in the [common behaviour](CapabilityStatement-pca-subscriber-agent.html#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](StructureDefinition-pca-organization.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
    capability statement.rest.resource.interaction:
      index: 1
      capability statement.rest.resource.interaction.code:
        value: patch
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **patch** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#patch)) of an ```Organization``` resource. **Behaviour**: This operation is used to update an identified ```Organization``` resource that conforms to the [PCA Organization](StructureDefinition-pca-organization.html) 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](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-partner-service.html) 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 confor…
    capability statement.rest.resource.versioning:
      value: versioned
    capability statement.rest.resource.read history:
      value: false
    capability statement.rest.resource.update create:
      value: false
    capability statement.rest.resource.conditional create:
      value: false
    capability statement.rest.resource.conditional read:
      value: not-supported
    capability statement.rest.resource.conditional update:
      value: false
    capability statement.rest.resource.conditional delete:
      value: not-supported
  capability statement.rest.resource:
    index: 1
    capability statement.rest.resource.type:
      value: Location
    capability statement.rest.resource.profile:
      value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-location
      link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-location
    capability statement.rest.resource.documentation:
      value: This section defines the supported interactions for the [PCA Location](StructureDefinition-pca-location.html) profile of the ```Location``` resource type. A ```Location``` resource conforming to the [PCA Location](StructureDefinition-pca-location.html) profile represents a location at which healthcare services are offered by a PCA publisher.
    capability statement.rest.resource.interaction:
      index: 0
      capability statement.rest.resource.interaction.code:
        value: read
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of a ```Location``` resource. **Behaviour**: This operation retrieves an identified ```Location``` resource that conforms to the [PCA Location](StructureDefinition-pca-location.html) profile. As described in the [common behaviour](CapabilityStatement-pca-subscriber-agent.html#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](StructureDefinition-pca-location.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
    capability statement.rest.resource.interaction:
      index: 1
      capability statement.rest.resource.interaction.code:
        value: patch
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **patch** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#patch)) of a ```Location``` resource. **Behaviour**: This operation is used to update an identified ```Location``` resource that conforms to the [PCA Location](StructureDefinition-pca-location.html) 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](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-partner-service.html) 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.ie…
    capability statement.rest.resource.versioning:
      value: versioned
    capability statement.rest.resource.read history:
      value: false
    capability statement.rest.resource.update create:
      value: false
    capability statement.rest.resource.conditional create:
      value: false
    capability statement.rest.resource.conditional read:
      value: not-supported
    capability statement.rest.resource.conditional update:
      value: false
    capability statement.rest.resource.conditional delete:
      value: not-supported
  capability statement.rest.resource:
    index: 2
    capability statement.rest.resource.type:
      value: HealthcareService
    capability statement.rest.resource.documentation:
      value: This section defines the supported interactions for the [PCA Healthcare Service](StructureDefinition-pca-healthcare-service.html) profile and the [PCA Partner Service](StructureDefinition-pca-partner-service.html) profile of the ```HealthcareService``` resource type. A ```HealthcareService``` resource conforming to the [PCA Healthcare Service](StructureDefinition-pca-healthcare-service.html) profile describes a healthcare service offered at a location by a PCA publisher. A ```HealthcareService``` resource conforming to the [PCA Partner Service](StructureDefinition-pca-partner-service.html) profile describes a partner service offered by a subscriber to which PCA publishers can publish their service offerings.
    capability statement.rest.resource.interaction:
      index: 0
      capability statement.rest.resource.interaction.code:
        value: read
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) 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](StructureDefinition-pca-healthcare-service.html) * [PCA Partner Service](StructureDefinition-pca-partner-service.html) As described [above](CapabilityStatement-pca-subscriber-agent.html#common-behaviour) a ```HealthcareService``` resource conforming to the [PCA Healthcare Service](StructureDefinition-pca-healthcare-service.html) 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](StructureDefinition-pca-healthcare-service.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
    capability statement.rest.resource.interaction:
      index: 1
      capability statement.rest.resource.interaction.code:
        value: patch
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **patch** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#patch)) of a ```HealthcareService``` resource. **Behaviour**: This operation is used to update an identified ```HealthcareService``` resource that conforms to the [PCA Healthcare Service](StructureDefinition-pca-healthcare-service.html) 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](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-partner-service.html) 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**:…
    capability statement.rest.resource.interaction:
      index: 2
      capability statement.rest.resource.interaction.code:
        value: search-type
      capability statement.rest.resource.interaction.documentation:
        value: **Definition**: This operation is a RESTful **search** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)) for ```HealthcareService``` resources that conform to the [PCA Partner Service](StructureDefinition-pca-partner-service.html) profile. **Behaviour**: The operation is used to find ```HealthcareService``` resources that that conform to the profile [PCA Partner Service](StructureDefinition-pca-partner-service.html) profile and that match the search parameters. Note that all [PCA Partner Service](StructureDefinition-pca-partner-service.html) 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](StructureDefinition-pca-partner-service.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
    capability statement.rest.resource.versioning:
      value: versioned
    capability statement.rest.resource.read history:
      value: false
    capability statement.rest.resource.update create:
      value: false
    capability statement.rest.resource.conditional create:
      value: false
    capability statement.rest.resource.conditional read:
      value: not-supported
    capability statement.rest.resource.conditional update:
      value: false
    capability statement.rest.resource.conditional delete:
      value: not-supported
    capability statement.rest.resource.search param:
      index: 0
      capability statement.rest.resource.search param.name:
        value: _profile
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/Resource-profile
        link: http://hl7.org/fhir/SearchParameter/Resource-profile
      capability statement.rest.resource.search param.type:
        value: uri
    capability statement.rest.resource.search param:
      index: 1
      capability statement.rest.resource.search param.name:
        value: active
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/HealthcareService-active
        link: http://hl7.org/fhir/SearchParameter/HealthcareService-active
      capability statement.rest.resource.search param.type:
        value: token
    capability statement.rest.resource.search param:
      index: 2
      capability statement.rest.resource.search param.name:
        value: organization
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/HealthcareService-organization
        link: http://hl7.org/fhir/SearchParameter/HealthcareService-organization
      capability statement.rest.resource.search param.type:
        value: reference
    capability statement.rest.resource.search param:
      index: 3
      capability statement.rest.resource.search param.name:
        value: service-catgeory
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/HealthcareService-service-category
        link: http://hl7.org/fhir/SearchParameter/HealthcareService-service-category
      capability statement.rest.resource.search param.type:
        value: token

value: OAuth

value: OAuth

index: 4
capability statement.rest.resource.search param.name:
  value: coverage-area.location.address-postalcode
capability statement.rest.resource.search param.type:
  value: string

index: 3
capability statement.rest.resource.type:
  value: PractitionerRole
capability statement.rest.resource.profile:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role
  link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Practitioner Role](StructureDefinition-pca-practitioner-role.html) profile of the ```PractitionerRole``` resource type. Each ```PractitionerRole``` resource conforming to the [PCA Practitioner Role](StructureDefinition-pca-practitioner-role.html) profile describes a practitioner in a role at a healthcare service.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of a ```PractitionerRole``` resource. **Behaviour**: This operation retrieves an identified ```PractitionerRole``` resource that conforms to the [PCA Practitioner Role](StructureDefinition-pca-practitioner-role.html) profile. As described in the [common behaviour](CapabilityStatement-pca-subscriber-agent.html#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](StructureDefinition-pca-practitioner-role.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: patch
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **patch** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#patch)) of a ```PractitionerRole``` resource. **Behaviour**: This operation is used to update an identified ```PractitionerRole``` resource that conforms to the [PCA Practitioner Role](StructureDefinition-pca-practitioner-role.html) 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](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-partner-service.html) 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 JS…
capability statement.rest.resource.versioning:
  value: versioned
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported
capability statement.rest.resource.search include:
  value: PractitionerRole:practitioner
  index: 0
capability statement.rest.resource.search include:
  value: PractitionerRole:healthcareService
  index: 1
capability statement.rest.resource.search include:
  value: PractitionerRole:organization
  index: 2
capability statement.rest.resource.search include:
  value: PractitionerRole:location
  index: 3

index: 4
capability statement.rest.resource.type:
  value: Practitioner
capability statement.rest.resource.profile:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner
  link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Practitioner](StructureDefinition-pca-practitioner.html) profile of the ```Practitioner``` resource type. Each ```Practitioner``` resource conforming the [PCA Practitioner](StructureDefinition-pca-practitioner.html) profile is a read-only proxy for a corresponding ```Practitioner``` resource 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.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of a ```Practitioner``` resource. **Behaviour**: This operation retrieves an identified ```Practitioner``` resource that conforms to the [PCA Practitioner](StructureDefinition-pca-practitioner.html) profile. As described in the [common behaviour](CapabilityStatement-pca-subscriber-agent.html#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](StructureDefinition-pca-practitioner.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.versioning:
  value: versioned
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported

index: 5
capability statement.rest.resource.type:
  value: Provenance
capability statement.rest.resource.profile:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-provenance
  link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-provenance
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Provenance](StructureDefinition-pca-provenance.html) profile of the ```Provenance``` resource type. Each ```Provenance``` resource conforming to the [PCA Provenance](StructureDefinition-pca-provenance.html) 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.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of a ```Provenance``` resource. **Behaviour**: This operation retrieves an identified ```Provenance``` resource that conforms to the [PCA Provenance](StructureDefinition-pca-practitioner-role.html) 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](StructureDefinition-pca-provenance.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.versioning:
  value: no-version
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported

index: 6
capability statement.rest.resource.type:
  value: Contract
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Publication Authorisation Record](StructureDefinition-pca-publication-authorisation-record.html) profile and the [PCA Information Use Statement](StructureDefinition-pca-information-use-statement.html) profile of the ```Contract``` resource type. A ```Contract``` resource conforming to the [PCA Publication Authorisation Record](StructureDefinition-pca-publication-authorisation-record.html) profile records a decision regarding the publication of a specific service offering (either a ```HealthcareService``` or a ```PractitionerRole```) to a specific partner service. The decision is either to authorise publication or to revoke a previous authority to publish. A ```Contract``` resource conforming to the [PCA Information Use Statement](StructureDefinition-pca-information-use-statement.html) 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.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) 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](StructureDefinition-pca-publication-authorisation-record.html) * [PCA Information Use Statement](StructureDefinition-pca-information-use-statement.html) 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](StructureDefinition-pca-publication-authorisation-record.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: search-type
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **search** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)) for ```Contract``` resources. **Behaviour**: This operation is used to find ```Contract``` resources that conform to the [PCA Information Use Statement](StructureDefinition-pca-information-use-statement) profile and that match the search parameters. Note that all [PCA Information Use Statement](StructureDefinition-pca-information-use-statement.html) 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](StructureDefinition-pca-information-use-statement.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.versioning:
  value: versioned
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported
capability statement.rest.resource.search param:
  index: 0
  capability statement.rest.resource.search param.name:
    value: _profile
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Resource-profile
    link: http://hl7.org/fhir/SearchParameter/Resource-profile
  capability statement.rest.resource.search param.type:
    value: uri
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: subject
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Contract-subject
    link: http://hl7.org/fhir/SearchParameter/Contract-subject
  capability statement.rest.resource.search param.type:
    value: reference
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: version
  capability statement.rest.resource.search param.type:
    value: string

index: 7
capability statement.rest.resource.type:
  value: Task
capability statement.rest.resource.profile:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-match-record
  link: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-match-record
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Match Record](StructureDefinition-pca-match-record.html) profile of the ```Task``` resource type. A ```Task``` resource conforming to the [PCA Match Record](StructureDefinition-pca-match-record.html) profile indicates the matching status of a service offering to a partner service’s local data store.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **read** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#read)) of a ```Task``` resource. **Behaviour**: This operation retrieves an identified ```Task``` resource that conforms to the [PCA Match Record](StructureDefinition-pca-match-record.html) profile. **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](StructureDefinition-pca-match-record.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: create
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **create** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#create)) of a ```Task``` resource conforming to the [PCA Match Record](StructureDefinition-pca-match-record.html) profile. **Behaviour**: 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: * The resource **SHALL** conform to the [PCA Match Record](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-partner-service.html) associated with the target PCA Subscriber Agent. * *owner* **SHALL** reference a [Partner Service](StructureDefinition-pca-partner-service.html) associated with the target PCA Subscriber Agent. * *note.text* **SHALL** be a maximum of 200 characters. **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](StructureDefinition-pca-match-record.html) 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](StructureDefinition-pca-match-record.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR…
capability statement.rest.resource.interaction:
  index: 2
  capability statement.rest.resource.interaction.code:
    value: update
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **update** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#update)) of a ```Task``` resource. **Behaviour**: 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: * The resource **SHALL** conform to the [PCA Match Record](StructureDefinition-pca-match-record.html) 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. * *owner* **SHALL** reference a [Partner Service](StructureDefinition-pca-partner-service.html) 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. 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. **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](StructureDef…
capability statement.rest.resource.versioning:
  value: versioned-update
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported

index: 8
capability statement.rest.resource.type:
  value: Subscription
capability statement.rest.resource.profile:
  value: http://hl7.org/fhir/StructureDefinition/Subscription
  link: http://hl7.org/fhir/StructureDefinition/Subscription
capability statement.rest.resource.documentation:
  value: This section defines the supported interactions for the [PCA Subscription](StructureDefinition-pca-subscription.html) profile of the ```Subscription``` resource type. The [PCA Subscription](StructureDefinition-pca-subscription.html) profile of ```Subscription``` is used by subscribing systems to register for notifications from the PCA service when new or updated service offerings are available, or when publication of existing service offerings has been newly revoked.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: create
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **create** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#create)) of a ```Subscription``` resource conforming to the [PCA Subscription](StructureDefinition-pca-subscription.html) 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](CapabilityStatement-pca-subscriber-agent.html#search-system). 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-T…
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: search-type
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **search** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)) for a ```Subscription``` resource that is associated with the target Subscriber Agent and that conforms to the [PCA Subscription](StructureDefinition-pca-subscription.html) 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](StructureDefinition-pca-subscription.html) 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](StructureDefinition-pca-subscription.html) profile. * Error: ```OperationOutcome``` resource (see [FHIR specification](https://www.hl7.org/fhir/operationoutcome.html)). **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.
capability statement.rest.resource.interaction:
  index: 2
  capability statement.rest.resource.interaction.code:
    value: delete
  capability statement.rest.resource.interaction.documentation:
    value: **Definition**: This operation is a RESTful **delete** interaction (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#delete)) 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.
capability statement.rest.resource.versioning:
  value: no-version
capability statement.rest.resource.read history:
  value: false
capability statement.rest.resource.update create:
  value: false
capability statement.rest.resource.conditional create:
  value: false
capability statement.rest.resource.conditional read:
  value: not-supported
capability statement.rest.resource.conditional update:
  value: false
capability statement.rest.resource.conditional delete:
  value: not-supported

index: 0
capability statement.rest.interaction.code:
  value: search-system
capability statement.rest.interaction.documentation:
  value: **Definition**: This operation is a RESTful *search* interaction (whole system interaction), across multiple resource types (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)). **Behaviour**: This operation is used by a client system operated by a subscriber organisation to get resources that match the specified search parameters and that have been published to the subscriber organisation's partner services. The following search parameters are supported: * *_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 Subscriber 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: * ```HealthcareService``` (returns resources conforming to the [PCA Healthcare Service](StructureDefinition-pca-healthcare-service.html) profile) * ```PractitionerRole``` (returns resources conforming to the [PCA Practitioner Role](StructureDefinition-pca-practitioner-role.html) profile) * ```Organization``` (returns resources conforming to the [PCA Organization](StructureDefinition-pca-organization.html) profile) * ```Location``` (returns resources conforming to the [PCA Location](StructureDefinition-pca-location.html) profile) * ```Practitioner``` (returns resources conforming to the [PCA Practitioner](StructureDefinition-pca-practitioner.html) profile) * ```Provenance``` (returns resources conforming to the [PCA Provenance](StructureDefinition-pca-provenance.html) profile) * ```Contract``` (returns resources conforming to the [PCA Publication Authorisation Record](StructureDefinition-pca-publication-authorisation-record.html) profile) * ```Task``` (returns resources conforming to the [PCA Match Record](StructureDefinition-pca-match-record.html) profile) * Note: a ```Contract``` resource with 'status' of 'revoked' indiates that a servi…

index: 0
capability statement.rest.resource.search param.name:
  value: _lastUpdated
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
capability statement.rest.resource.search param.type:
  value: date

index: 1
capability statement.rest.resource.search param.name:
  value: _type
capability statement.rest.resource.search param.type:
  value: token

index: 2
capability statement.rest.resource.search param.name:
  value: _include
capability statement.rest.resource.search param.type:
  value: special

index: 3
capability statement.rest.resource.search param.name:
  value: _include:iterate
capability statement.rest.resource.search param.type:
  value: special

index: 4
capability statement.rest.resource.search param.name:
  value: _filter
capability statement.rest.resource.search param.type:
  value: special

index: 5
capability statement.rest.resource.search param.name:
  value: _page
capability statement.rest.resource.search param.type:
  value: special

index: 6
capability statement.rest.resource.search param.name:
  value: _count
capability statement.rest.resource.search param.type:
  value: special

index: 7
capability statement.rest.resource.search param.name:
  value: _resultId
capability statement.rest.resource.search param.type:
  value: special