Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
Genomic-Plandefinition-Actor-Role
SearchParameter for searching on PlanDefinition by the PlanDefinition.actor.option.role element represented in FHIR R4 using the HL7 cross-version extension:
http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor
This element is used to identify the role of a participant associated with the genomic test, for example a requester or performer.
Example usage:
GET [base]/PlanDefinition?actor-role=https://fhir.nhs.uk/CodeSystem/action-participant-role-genomics|requester
HTML View
Invocations
[base]/PlanDefinition?actor-role=[system]|[value]
Details
| Resource | PlanDefinition |
|---|---|
| Code | actor-role |
| Type | token |
| FhirPath | PlanDefinition.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor').extension('option').extension('role').value |
Table View
| SearchParameter.id[0] | SearchParameter-plandefinition-actor-role |
| SearchParameter.url[0] | https://fhir.nhs.uk/SearchParameter/plandefinition-actor-role |
| SearchParameter.version[0] | 0.1.0 |
| SearchParameter.name[0] | PlanDefinition Actor Role |
| SearchParameter.status[0] | draft |
| SearchParameter.experimental[0] | False |
| SearchParameter.date[0] | 2026-05-19 |
| SearchParameter.publisher[0] | NHS England |
| SearchParameter.description[0] | Search PlanDefinition by actor option role from the R5 cross-version extension extension-PlanDefinition.actor |
| SearchParameter.code[0] | actor-role |
| SearchParameter.base[0] | PlanDefinition |
| SearchParameter.type[0] | token |
| SearchParameter.expression[0] | PlanDefinition.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor').extension('option').extension('role').value |
| SearchParameter.multipleOr[0] | True |
| SearchParameter.multipleAnd[0] | True |
XML View
<description value="Search PlanDefinition by actor option role from the R5 cross-version extension extension-PlanDefinition.actor" />
<expression value="PlanDefinition.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor').extension('option').extension('role').value" />
</SearchParameter>
JSON View
{
"description": "Search PlanDefinition by actor option role from the R5 cross-version extension extension-PlanDefinition.actor",
"PlanDefinition"
],
"expression": "PlanDefinition.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor').extension('option').extension('role').value",
}