PCA™ - Include and iterate

Quick intro#

In some cases where the requesting subscription system is stateless or in events where you want all elements referenced irrespective of whether they have changed, a requesting system may use other filter expressions.

_include search parameter#

The _include search parameter will return the resource rather than the references in Bundle

The mode is used to differentiate whether the resource returned is based on a “match” in the URL request or whether it is as part of “include”

The inclusion process can be iterative, if (and only if) the modifier :iterate is included

The following parameters are supported:

_include=Location:organization
_include=HealthcareService:organization
_include=HealthcareService:location
_include=PractitionerRole:organization
_include=PractitionerRole:location
_include=PractitionerRole:service
_include=PractitionerRole:practitioner
_include=Provenance:target
_include=Contract:subject
_include:iterate=HealthcareService:organization
_include:iterate=HealthcareService:location
_include:iterate=PractitionerRole:organization
_include:iterate=PractitionerRole:location
_include:iterate=PractitionerRole:service
_include:iterate=PractitionerRole:practitioner

 Home | Back: Count and paging | Next: Update business partner identifier