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.
SearchParameters
Only one custom search parameter has been defined for genomics as of publication but it expected search parameters for searching ServiceRequests and Diagnostic reports mey need to be added in future iterations, pending requirements gathering.
The list of common search parameters to be supported by the central GMS infrastructure are listed in the Instance CapabilityStatement page.
Search Parameters defined for use in Genomics:
Genomic-ServiceRequest-supportingInfo
SearchParameter for searching on supportingInfo references within ServiceRequests, this also allows inclusion of the referenced resources via the _include parameter, e.g.
GET [base]/ServiceRequest?_include=ServiceRequest:supporting-info:Consent
HTML View
Invocations
[base]/ServiceRequest?supporting-info=Account/[id][base]/ServiceRequest?supporting-info=ActivityDefinition/[id][base]/ServiceRequest?supporting-info=AdverseEvent/[id][base]/ServiceRequest?supporting-info=AllergyIntolerance/[id][base]/ServiceRequest?supporting-info=Appointment/[id][base]/ServiceRequest?supporting-info=AppointmentResponse/[id][base]/ServiceRequest?supporting-info=AuditEvent/[id][base]/ServiceRequest?supporting-info=Basic/[id][base]/ServiceRequest?supporting-info=Binary/[id][base]/ServiceRequest?supporting-info=BiologicallyDerivedProduct/[id][base]/ServiceRequest?supporting-info=BodyStructure/[id][base]/ServiceRequest?supporting-info=Bundle/[id][base]/ServiceRequest?supporting-info=CapabilityStatement/[id][base]/ServiceRequest?supporting-info=CarePlan/[id][base]/ServiceRequest?supporting-info=CareTeam/[id][base]/ServiceRequest?supporting-info=CatalogEntry/[id][base]/ServiceRequest?supporting-info=ChargeItem/[id][base]/ServiceRequest?supporting-info=ChargeItemDefinition/[id][base]/ServiceRequest?supporting-info=Claim/[id][base]/ServiceRequest?supporting-info=ClaimResponse/[id][base]/ServiceRequest?supporting-info=ClinicalImpression/[id][base]/ServiceRequest?supporting-info=CodeSystem/[id][base]/ServiceRequest?supporting-info=Communication/[id][base]/ServiceRequest?supporting-info=CommunicationRequest/[id][base]/ServiceRequest?supporting-info=CompartmentDefinition/[id][base]/ServiceRequest?supporting-info=Composition/[id][base]/ServiceRequest?supporting-info=ConceptMap/[id][base]/ServiceRequest?supporting-info=Condition/[id][base]/ServiceRequest?supporting-info=Consent/[id][base]/ServiceRequest?supporting-info=Contract/[id][base]/ServiceRequest?supporting-info=Coverage/[id][base]/ServiceRequest?supporting-info=CoverageEligibilityRequest/[id][base]/ServiceRequest?supporting-info=CoverageEligibilityResponse/[id][base]/ServiceRequest?supporting-info=DetectedIssue/[id][base]/ServiceRequest?supporting-info=Device/[id][base]/ServiceRequest?supporting-info=DeviceDefinition/[id][base]/ServiceRequest?supporting-info=DeviceMetric/[id][base]/ServiceRequest?supporting-info=DeviceRequest/[id][base]/ServiceRequest?supporting-info=DeviceUseStatement/[id][base]/ServiceRequest?supporting-info=DiagnosticReport/[id][base]/ServiceRequest?supporting-info=DocumentManifest/[id][base]/ServiceRequest?supporting-info=DocumentReference/[id][base]/ServiceRequest?supporting-info=EffectEvidenceSynthesis/[id][base]/ServiceRequest?supporting-info=Encounter/[id][base]/ServiceRequest?supporting-info=Endpoint/[id][base]/ServiceRequest?supporting-info=EnrollmentRequest/[id][base]/ServiceRequest?supporting-info=EnrollmentResponse/[id][base]/ServiceRequest?supporting-info=EpisodeOfCare/[id][base]/ServiceRequest?supporting-info=EventDefinition/[id][base]/ServiceRequest?supporting-info=Evidence/[id][base]/ServiceRequest?supporting-info=EvidenceVariable/[id][base]/ServiceRequest?supporting-info=ExampleScenario/[id][base]/ServiceRequest?supporting-info=ExplanationOfBenefit/[id][base]/ServiceRequest?supporting-info=FamilyMemberHistory/[id][base]/ServiceRequest?supporting-info=Flag/[id][base]/ServiceRequest?supporting-info=Goal/[id][base]/ServiceRequest?supporting-info=GraphDefinition/[id][base]/ServiceRequest?supporting-info=Group/[id][base]/ServiceRequest?supporting-info=GuidanceResponse/[id][base]/ServiceRequest?supporting-info=HealthcareService/[id][base]/ServiceRequest?supporting-info=ImagingStudy/[id][base]/ServiceRequest?supporting-info=Immunization/[id][base]/ServiceRequest?supporting-info=ImmunizationEvaluation/[id][base]/ServiceRequest?supporting-info=ImmunizationRecommendation/[id][base]/ServiceRequest?supporting-info=ImplementationGuide/[id][base]/ServiceRequest?supporting-info=InsurancePlan/[id][base]/ServiceRequest?supporting-info=Invoice/[id][base]/ServiceRequest?supporting-info=Library/[id][base]/ServiceRequest?supporting-info=Linkage/[id][base]/ServiceRequest?supporting-info=List/[id][base]/ServiceRequest?supporting-info=Location/[id][base]/ServiceRequest?supporting-info=Measure/[id][base]/ServiceRequest?supporting-info=MeasureReport/[id][base]/ServiceRequest?supporting-info=Media/[id][base]/ServiceRequest?supporting-info=Medication/[id][base]/ServiceRequest?supporting-info=MedicationAdministration/[id][base]/ServiceRequest?supporting-info=MedicationDispense/[id][base]/ServiceRequest?supporting-info=MedicationKnowledge/[id][base]/ServiceRequest?supporting-info=MedicationRequest/[id][base]/ServiceRequest?supporting-info=MedicationStatement/[id][base]/ServiceRequest?supporting-info=MedicinalProduct/[id][base]/ServiceRequest?supporting-info=MedicinalProductAuthorization/[id][base]/ServiceRequest?supporting-info=MedicinalProductContraindication/[id][base]/ServiceRequest?supporting-info=MedicinalProductIndication/[id][base]/ServiceRequest?supporting-info=MedicinalProductIngredient/[id][base]/ServiceRequest?supporting-info=MedicinalProductInteraction/[id][base]/ServiceRequest?supporting-info=MedicinalProductManufactured/[id][base]/ServiceRequest?supporting-info=MedicinalProductPackaged/[id][base]/ServiceRequest?supporting-info=MedicinalProductPharmaceutical/[id][base]/ServiceRequest?supporting-info=MedicinalProductUndesirableEffect/[id][base]/ServiceRequest?supporting-info=MessageDefinition/[id][base]/ServiceRequest?supporting-info=MessageHeader/[id][base]/ServiceRequest?supporting-info=MolecularSequence/[id][base]/ServiceRequest?supporting-info=NamingSystem/[id][base]/ServiceRequest?supporting-info=NutritionOrder/[id][base]/ServiceRequest?supporting-info=Observation/[id][base]/ServiceRequest?supporting-info=ObservationDefinition/[id][base]/ServiceRequest?supporting-info=OperationDefinition/[id][base]/ServiceRequest?supporting-info=OperationOutcome/[id][base]/ServiceRequest?supporting-info=Organization/[id][base]/ServiceRequest?supporting-info=OrganizationAffiliation/[id][base]/ServiceRequest?supporting-info=Patient/[id][base]/ServiceRequest?supporting-info=PaymentNotice/[id][base]/ServiceRequest?supporting-info=PaymentReconciliation/[id][base]/ServiceRequest?supporting-info=Person/[id][base]/ServiceRequest?supporting-info=PlanDefinition/[id][base]/ServiceRequest?supporting-info=Practitioner/[id][base]/ServiceRequest?supporting-info=PractitionerRole/[id][base]/ServiceRequest?supporting-info=Procedure/[id][base]/ServiceRequest?supporting-info=Provenance/[id][base]/ServiceRequest?supporting-info=Questionnaire/[id][base]/ServiceRequest?supporting-info=QuestionnaireResponse/[id][base]/ServiceRequest?supporting-info=RelatedPerson/[id][base]/ServiceRequest?supporting-info=RequestGroup/[id][base]/ServiceRequest?supporting-info=ResearchDefinition/[id][base]/ServiceRequest?supporting-info=ResearchElementDefinition/[id][base]/ServiceRequest?supporting-info=ResearchStudy/[id][base]/ServiceRequest?supporting-info=ResearchSubject/[id][base]/ServiceRequest?supporting-info=RiskAssessment/[id][base]/ServiceRequest?supporting-info=RiskEvidenceSynthesis/[id][base]/ServiceRequest?supporting-info=Schedule/[id][base]/ServiceRequest?supporting-info=SearchParameter/[id][base]/ServiceRequest?supporting-info=ServiceRequest/[id][base]/ServiceRequest?supporting-info=Slot/[id][base]/ServiceRequest?supporting-info=Specimen/[id][base]/ServiceRequest?supporting-info=SpecimenDefinition/[id][base]/ServiceRequest?supporting-info=StructureDefinition/[id][base]/ServiceRequest?supporting-info=StructureMap/[id][base]/ServiceRequest?supporting-info=Subscription/[id][base]/ServiceRequest?supporting-info=Substance/[id][base]/ServiceRequest?supporting-info=SubstanceNucleicAcid/[id][base]/ServiceRequest?supporting-info=SubstancePolymer/[id][base]/ServiceRequest?supporting-info=SubstanceProtein/[id][base]/ServiceRequest?supporting-info=SubstanceReferenceInformation/[id][base]/ServiceRequest?supporting-info=SubstanceSourceMaterial/[id][base]/ServiceRequest?supporting-info=SubstanceSpecification/[id][base]/ServiceRequest?supporting-info=SupplyDelivery/[id][base]/ServiceRequest?supporting-info=SupplyRequest/[id][base]/ServiceRequest?supporting-info=Task/[id][base]/ServiceRequest?supporting-info=TerminologyCapabilities/[id][base]/ServiceRequest?supporting-info=TestReport/[id][base]/ServiceRequest?supporting-info=TestScript/[id][base]/ServiceRequest?supporting-info=ValueSet/[id][base]/ServiceRequest?supporting-info=VerificationResult/[id][base]/ServiceRequest?supporting-info=VisionPrescription/[id]
Details
| Resource | ServiceRequest |
|---|---|
| Code | supporting-info |
| Type | reference |
| FhirPath | ServiceRequest.supportingInfo |
Table View
| SearchParameter.id[0] | SearchParameter-Genomics-supporting-info |
| SearchParameter.url[0] | https://fhir.nhs.uk/SearchParameter/supporting-info |
| SearchParameter.version[0] | 0.0.1 |
| SearchParameter.name[0] | SupportingInfo |
| SearchParameter.status[0] | draft |
| SearchParameter.experimental[0] | False |
| SearchParameter.date[0] | 2023-06-27T09:56:00+00:00 |
| SearchParameter.publisher[0] | NHS England |
| SearchParameter.description[0] | Supporting info for a ServiceRequest |
| SearchParameter.purpose[0] | For searching resources referenced from ServiceRequest.supportingInfo |
| SearchParameter.code[0] | supporting-info |
| SearchParameter.base[0] | ServiceRequest |
| SearchParameter.type[0] | reference |
| SearchParameter.expression[0] | ServiceRequest.supportingInfo |
| SearchParameter.target[0] | Account |
| SearchParameter.target[1] | ActivityDefinition |
| SearchParameter.target[2] | AdverseEvent |
| SearchParameter.target[3] | AllergyIntolerance |
| SearchParameter.target[4] | Appointment |
| SearchParameter.target[5] | AppointmentResponse |
| SearchParameter.target[6] | AuditEvent |
| SearchParameter.target[7] | Basic |
| SearchParameter.target[8] | Binary |
| SearchParameter.target[9] | BiologicallyDerivedProduct |
| SearchParameter.target[10] | BodyStructure |
| SearchParameter.target[11] | Bundle |
| SearchParameter.target[12] | CapabilityStatement |
| SearchParameter.target[13] | CarePlan |
| SearchParameter.target[14] | CareTeam |
| SearchParameter.target[15] | CatalogEntry |
| SearchParameter.target[16] | ChargeItem |
| SearchParameter.target[17] | ChargeItemDefinition |
| SearchParameter.target[18] | Claim |
| SearchParameter.target[19] | ClaimResponse |
| SearchParameter.target[20] | ClinicalImpression |
| SearchParameter.target[21] | CodeSystem |
| SearchParameter.target[22] | Communication |
| SearchParameter.target[23] | CommunicationRequest |
| SearchParameter.target[24] | CompartmentDefinition |
| SearchParameter.target[25] | Composition |
| SearchParameter.target[26] | ConceptMap |
| SearchParameter.target[27] | Condition |
| SearchParameter.target[28] | Consent |
| SearchParameter.target[29] | Contract |
| SearchParameter.target[30] | Coverage |
| SearchParameter.target[31] | CoverageEligibilityRequest |
| SearchParameter.target[32] | CoverageEligibilityResponse |
| SearchParameter.target[33] | DetectedIssue |
| SearchParameter.target[34] | Device |
| SearchParameter.target[35] | DeviceDefinition |
| SearchParameter.target[36] | DeviceMetric |
| SearchParameter.target[37] | DeviceRequest |
| SearchParameter.target[38] | DeviceUseStatement |
| SearchParameter.target[39] | DiagnosticReport |
| SearchParameter.target[40] | DocumentManifest |
| SearchParameter.target[41] | DocumentReference |
| SearchParameter.target[42] | EffectEvidenceSynthesis |
| SearchParameter.target[43] | Encounter |
| SearchParameter.target[44] | Endpoint |
| SearchParameter.target[45] | EnrollmentRequest |
| SearchParameter.target[46] | EnrollmentResponse |
| SearchParameter.target[47] | EpisodeOfCare |
| SearchParameter.target[48] | EventDefinition |
| SearchParameter.target[49] | Evidence |
| SearchParameter.target[50] | EvidenceVariable |
| SearchParameter.target[51] | ExampleScenario |
| SearchParameter.target[52] | ExplanationOfBenefit |
| SearchParameter.target[53] | FamilyMemberHistory |
| SearchParameter.target[54] | Flag |
| SearchParameter.target[55] | Goal |
| SearchParameter.target[56] | GraphDefinition |
| SearchParameter.target[57] | Group |
| SearchParameter.target[58] | GuidanceResponse |
| SearchParameter.target[59] | HealthcareService |
| SearchParameter.target[60] | ImagingStudy |
| SearchParameter.target[61] | Immunization |
| SearchParameter.target[62] | ImmunizationEvaluation |
| SearchParameter.target[63] | ImmunizationRecommendation |
| SearchParameter.target[64] | ImplementationGuide |
| SearchParameter.target[65] | InsurancePlan |
| SearchParameter.target[66] | Invoice |
| SearchParameter.target[67] | Library |
| SearchParameter.target[68] | Linkage |
| SearchParameter.target[69] | List |
| SearchParameter.target[70] | Location |
| SearchParameter.target[71] | Measure |
| SearchParameter.target[72] | MeasureReport |
| SearchParameter.target[73] | Media |
| SearchParameter.target[74] | Medication |
| SearchParameter.target[75] | MedicationAdministration |
| SearchParameter.target[76] | MedicationDispense |
| SearchParameter.target[77] | MedicationKnowledge |
| SearchParameter.target[78] | MedicationRequest |
| SearchParameter.target[79] | MedicationStatement |
| SearchParameter.target[80] | MedicinalProduct |
| SearchParameter.target[81] | MedicinalProductAuthorization |
| SearchParameter.target[82] | MedicinalProductContraindication |
| SearchParameter.target[83] | MedicinalProductIndication |
| SearchParameter.target[84] | MedicinalProductIngredient |
| SearchParameter.target[85] | MedicinalProductInteraction |
| SearchParameter.target[86] | MedicinalProductManufactured |
| SearchParameter.target[87] | MedicinalProductPackaged |
| SearchParameter.target[88] | MedicinalProductPharmaceutical |
| SearchParameter.target[89] | MedicinalProductUndesirableEffect |
| SearchParameter.target[90] | MessageDefinition |
| SearchParameter.target[91] | MessageHeader |
| SearchParameter.target[92] | MolecularSequence |
| SearchParameter.target[93] | NamingSystem |
| SearchParameter.target[94] | NutritionOrder |
| SearchParameter.target[95] | Observation |
| SearchParameter.target[96] | ObservationDefinition |
| SearchParameter.target[97] | OperationDefinition |
| SearchParameter.target[98] | OperationOutcome |
| SearchParameter.target[99] | Organization |
| SearchParameter.target[100] | OrganizationAffiliation |
| SearchParameter.target[101] | Patient |
| SearchParameter.target[102] | PaymentNotice |
| SearchParameter.target[103] | PaymentReconciliation |
| SearchParameter.target[104] | Person |
| SearchParameter.target[105] | PlanDefinition |
| SearchParameter.target[106] | Practitioner |
| SearchParameter.target[107] | PractitionerRole |
| SearchParameter.target[108] | Procedure |
| SearchParameter.target[109] | Provenance |
| SearchParameter.target[110] | Questionnaire |
| SearchParameter.target[111] | QuestionnaireResponse |
| SearchParameter.target[112] | RelatedPerson |
| SearchParameter.target[113] | RequestGroup |
| SearchParameter.target[114] | ResearchDefinition |
| SearchParameter.target[115] | ResearchElementDefinition |
| SearchParameter.target[116] | ResearchStudy |
| SearchParameter.target[117] | ResearchSubject |
| SearchParameter.target[118] | RiskAssessment |
| SearchParameter.target[119] | RiskEvidenceSynthesis |
| SearchParameter.target[120] | Schedule |
| SearchParameter.target[121] | SearchParameter |
| SearchParameter.target[122] | ServiceRequest |
| SearchParameter.target[123] | Slot |
| SearchParameter.target[124] | Specimen |
| SearchParameter.target[125] | SpecimenDefinition |
| SearchParameter.target[126] | StructureDefinition |
| SearchParameter.target[127] | StructureMap |
| SearchParameter.target[128] | Subscription |
| SearchParameter.target[129] | Substance |
| SearchParameter.target[130] | SubstanceNucleicAcid |
| SearchParameter.target[131] | SubstancePolymer |
| SearchParameter.target[132] | SubstanceProtein |
| SearchParameter.target[133] | SubstanceReferenceInformation |
| SearchParameter.target[134] | SubstanceSourceMaterial |
| SearchParameter.target[135] | SubstanceSpecification |
| SearchParameter.target[136] | SupplyDelivery |
| SearchParameter.target[137] | SupplyRequest |
| SearchParameter.target[138] | Task |
| SearchParameter.target[139] | TerminologyCapabilities |
| SearchParameter.target[140] | TestReport |
| SearchParameter.target[141] | TestScript |
| SearchParameter.target[142] | ValueSet |
| SearchParameter.target[143] | VerificationResult |
| SearchParameter.target[144] | VisionPrescription |
| SearchParameter.multipleOr[0] | True |
| SearchParameter.multipleAnd[0] | True |
| SearchParameter.modifier[0] | missing |
| SearchParameter.modifier[1] | type |
| SearchParameter.modifier[2] | identifier |
XML View
</SearchParameter>
JSON View
{
"ServiceRequest"
],
"Account",
"ActivityDefinition",
"AdverseEvent",
"AllergyIntolerance",
"Appointment",
"AppointmentResponse",
"AuditEvent",
"Basic",
"Binary",
"BiologicallyDerivedProduct",
"BodyStructure",
"Bundle",
"CapabilityStatement",
"CarePlan",
"CareTeam",
"CatalogEntry",
"ChargeItem",
"ChargeItemDefinition",
"Claim",
"ClaimResponse",
"ClinicalImpression",
"CodeSystem",
"Communication",
"CommunicationRequest",
"CompartmentDefinition",
"Composition",
"ConceptMap",
"Condition",
"Consent",
"Contract",
"Coverage",
"CoverageEligibilityRequest",
"CoverageEligibilityResponse",
"DetectedIssue",
"Device",
"DeviceDefinition",
"DeviceMetric",
"DeviceRequest",
"DeviceUseStatement",
"DiagnosticReport",
"DocumentManifest",
"DocumentReference",
"EffectEvidenceSynthesis",
"Encounter",
"Endpoint",
"EnrollmentRequest",
"EnrollmentResponse",
"EpisodeOfCare",
"EventDefinition",
"Evidence",
"EvidenceVariable",
"ExampleScenario",
"ExplanationOfBenefit",
"FamilyMemberHistory",
"Flag",
"Goal",
"GraphDefinition",
"Group",
"GuidanceResponse",
"HealthcareService",
"ImagingStudy",
"Immunization",
"ImmunizationEvaluation",
"ImmunizationRecommendation",
"ImplementationGuide",
"InsurancePlan",
"Invoice",
"Library",
"Linkage",
"List",
"Location",
"Measure",
"MeasureReport",
"Media",
"Medication",
"MedicationAdministration",
"MedicationDispense",
"MedicationKnowledge",
"MedicationRequest",
"MedicationStatement",
"MedicinalProduct",
"MedicinalProductAuthorization",
"MedicinalProductContraindication",
"MedicinalProductIndication",
"MedicinalProductIngredient",
"MedicinalProductInteraction",
"MedicinalProductManufactured",
"MedicinalProductPackaged",
"MedicinalProductPharmaceutical",
"MedicinalProductUndesirableEffect",
"MessageDefinition",
"MessageHeader",
"MolecularSequence",
"NamingSystem",
"NutritionOrder",
"Observation",
"ObservationDefinition",
"OperationDefinition",
"OperationOutcome",
"Organization",
"OrganizationAffiliation",
"Patient",
"PaymentNotice",
"PaymentReconciliation",
"Person",
"PlanDefinition",
"Practitioner",
"PractitionerRole",
"Procedure",
"Provenance",
"Questionnaire",
"QuestionnaireResponse",
"RelatedPerson",
"RequestGroup",
"ResearchDefinition",
"ResearchElementDefinition",
"ResearchStudy",
"ResearchSubject",
"RiskAssessment",
"RiskEvidenceSynthesis",
"Schedule",
"SearchParameter",
"ServiceRequest",
"Slot",
"Specimen",
"SpecimenDefinition",
"StructureDefinition",
"StructureMap",
"Subscription",
"Substance",
"SubstanceNucleicAcid",
"SubstancePolymer",
"SubstanceProtein",
"SubstanceReferenceInformation",
"SubstanceSourceMaterial",
"SubstanceSpecification",
"SupplyDelivery",
"SupplyRequest",
"Task",
"TerminologyCapabilities",
"TestReport",
"TestScript",
"ValueSet",
"VerificationResult",
"VisionPrescription"
],
"missing",
"type",
"identifier"
]
}
Genomic-Specimen-request
SearchParameter for searching on request references within Specimen, this also allows inclusion of the referenced resources via the _include and _revInclude parameters, e.g.
GET [base]/Specimen?_include=Specimen:request
or
GET [base]/ServiceRequest?_id=[sr_id]&_revinclude=Specimen:request
HTML View
Invocations
[base]/Specimen?request=ServiceRequest/[id]
Details
| Resource | Specimen |
|---|---|
| Code | request |
| Type | reference |
| FhirPath | Specimen.request |
Table View
| SearchParameter.id[0] | SearchParameter-Genomics-request |
| SearchParameter.url[0] | https://fhir.nhs.uk/SearchParameter/request |
| SearchParameter.version[0] | 0.0.1 |
| SearchParameter.name[0] | Request |
| SearchParameter.status[0] | draft |
| SearchParameter.experimental[0] | False |
| SearchParameter.date[0] | 2024-08-01T09:35:00+00:00 |
| SearchParameter.publisher[0] | NHS England |
| SearchParameter.description[0] | Link to the triggering ServiceRequest for a Specimen resource |
| SearchParameter.purpose[0] | For searching resources referenced from Specimen.request |
| SearchParameter.code[0] | request |
| SearchParameter.base[0] | Specimen |
| SearchParameter.type[0] | reference |
| SearchParameter.expression[0] | Specimen.request |
| SearchParameter.target[0] | ServiceRequest |
| SearchParameter.multipleOr[0] | True |
| SearchParameter.multipleAnd[0] | False |
| SearchParameter.modifier[0] | missing |
| SearchParameter.modifier[1] | identifier |
XML View
</SearchParameter>
JSON View
{
"Specimen"
],
"ServiceRequest"
],
"missing",
"identifier"
]
}
Genomic-AuditEvent-entity-detail
SearchParameter for searching on AuditEvent by the AuditEvent.entity.detail element. This element will be used to capture the messageID. messageID is the identifier for the request message, as saved by SPLUNK, the logging service used by NHS England.
HTML View
Invocations
[base]/AuditEvent?entity-detail=[text]
Details
| Resource | AuditEvent |
|---|---|
| Code | entity-detail |
| Type | string |
| FhirPath | AuditEvent.entity.detail |
Table View
| SearchParameter.id[0] | SearchParameter-Genomics-entity-detail |
| SearchParameter.url[0] | https://fhir.nhs.uk/SearchParameter/entity-detail |
| SearchParameter.name[0] | EntityDetail |
| SearchParameter.status[0] | draft |
| SearchParameter.experimental[0] | False |
| SearchParameter.date[0] | 2024-09-20 |
| SearchParameter.publisher[0] | NHS England |
| SearchParameter.description[0] | Additional detail/metadata for AuditEvents |
| SearchParameter.purpose[0] | For searching for AuditEvents using the SPLUNK messageID, saved against the AuditEvent.entity.detail field |
| SearchParameter.code[0] | entity-detail |
| SearchParameter.base[0] | AuditEvent |
| SearchParameter.type[0] | string |
| SearchParameter.expression[0] | AuditEvent.entity.detail |
| SearchParameter.multipleOr[0] | True |
| SearchParameter.multipleAnd[0] | False |
XML View
<purpose value="For searching for AuditEvents using the SPLUNK messageID, saved against the AuditEvent.entity.detail field" />
</SearchParameter>
JSON View
{
"purpose": "For searching for AuditEvents using the SPLUNK messageID, saved against the AuditEvent.entity.detail field",
"AuditEvent"
],
}
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",
}
Genomic-PlanDefinition-Actor-Typereference
SearchParameter for searching on PlanDefinition by the PlanDefinition.actor.option.typeReference 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 reference the participating organisations associated with the genomic test workflow.
Example usage:
GET [base]/PlanDefinition?actor-type-reference:identifier=https://fhir.nhs.uk/Id/ods-organization-code|RYJ
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",
}