CapabilityStatements

The CapabilityStatements created specifically for use in Genomics are listed below. These include Requirements, defining the profiles to be targeted during validation, and CapabilityStatements defining the endpoints for the Genomic Medicine Service (currently in development).

The API interactions that make up the service are a combination of FHIR transactions which allow multiple resources to be created and updated at once, and instance level interactions to retrieve or update specific FHIR resources.

The central Test Order Service will expose all API endpoints to enable organisations to create and query test requests, tasks and linked FHIR Resources.

In the linked tables below the API interactions which can be used to create, update and search for information on the test ordering services are specified at a high level.

Note: The “Create ServiceRequest”, “Create Task” and “Create Specimen” are all FHIR resource level interactions and could all be performed within one transaction to reduce the number of API calls required, for example if a GLH creates a new specimen, which they are going to send to an LGL, they should POST the new Specimen, Task and all related resources in one request.

Requirements

REST Capabilities Server

ModeServer

Security

ServiceOAuth2 Token

Resource Interactions

Resource TypeProfileSupported Profiles
AuditEventAuditEvent
BundleBundle
CodeSystemCodeSystem
ConceptMapConceptMap
HealthcareServiceUK Core HealthcareService
MessageDefinitionMessageDefinition
NamingSystemNamingSystem
ParametersParameters
StructureMapStructureMap
ValueSetValueSet
MessageHeaderMessageHeader
SubscriptionSubscription
CapabilityStatementCapabilityStatement
TaskTask
ServiceRequestUK Core ServiceRequest
PractitionerRoleUK Core PractitionerRole
PractitionerUK Core Practitioner
OrganizationUK Core Organization
DiagnosticReportUK Core DiagnosticReport
FamilyMemberHistoryUKCore FamilyMemberHistory
ObservationUK Core Observation
PatientUK Core Patient
ConsentConsent
ConditionUK Core Condition
ResearchSubjectResearchSubject
RelatedPersonUK Core RelatedPerson
SpecimenUK Core Specimen
QuestionnaireQuestionnaire
QuestionnaireResponseQuestionnaireResponse
OperationDefinitionOperationDefinition
OperationOutcomeOperationOutcome
BodyStructureBodyStructure
ProvenanceProvenance

Instance

REST Capabilities Server

ModeServer
Documentation

RESTful endpoints supported by the Genomic Medicine Service

Security

ServiceOAuth2 Token

Resource Interactions

Resource TypeProfileSupported ProfilesReadSearchTypeCreateVreadUpdatePatchDeleteHistoryInstanceConditionalCreate
AuditEventAuditEvent
BundleBundle
CodeSystemCodeSystem
ConceptMapConceptMap
HealthcareServiceUK Core HealthcareService
MessageDefinitionMessageDefinition
NamingSystemNamingSystem
ParametersParameters
StructureMapStructureMap
ValueSetValueSet
MessageHeaderMessageHeader
SubscriptionSubscription
CapabilityStatementCapabilityStatement
TaskTask
ServiceRequestUK Core ServiceRequest
PractitionerRoleUK Core PractitionerRole
PractitionerUK Core Practitioner
OrganizationUK Core Organization
DiagnosticReportUK Core DiagnosticReport
FamilyMemberHistoryUKCore FamilyMemberHistory
ObservationUK Core Observation
PatientUK Core Patient
ConsentConsent
ConditionUK Core Condition
ResearchSubjectResearchSubject
RelatedPersonNHSDigital_RelatedPerson_Genomics
SpecimenUK Core Specimen
QuestionnaireQuestionnaire
QuestionnaireResponseQuestionnaireResponse
OperationDefinitionhttps://hl7.org/fhir/StructureDefinition/OperationDefinition
OperationOutcomeOperationOutcome
BodyStructureBodyStructure
ProvenanceProvenance

Search Parameters per resource type

AuditEvent

NameTypeLevel
actiontokenSupported
agentreferenceSupported
datedateSupported
entityreferenceSupported
outcometokenSupported
patientreferenceSupported

Bundle

No search parameters are stated for this resource type

CodeSystem

NameTypeLevel
codetokenSupported
contexttokenSupported
descriptionstringSupported
identifiertokenSupported
namestringSupported
systemuriSupported
titlestringSupported

ConceptMap

NameTypeLevel
contexttokenSupported
descriptionstringSupported
identifiertokenSupported
namestringSupported
source-systemuriSupported
target-systemuriSupported
titlestringSupported

HealthcareService

NameTypeLevel
coverage-areareferenceSupported
endpointreferenceSupported
identifiertokenSupported
namestringSupported
locationreferenceSupported
organizationreferenceSupported
service-categorytokenSupported
service-typetokenSupported
specialtytokenSupported

MessageDefinition

NameTypeLevel
descriptionstringSupported
identifiertokenSupported
namestringSupported
focustokenSupported
titlestringSupported

NamingSystem

NameTypeLevel
contexttokenSupported
descriptionstringSupported
namestringSupported

Parameters

No search parameters are stated for this resource type

StructureMap

NameTypeLevel
contexttokenSupported
descriptionstringSupported
identifiertokenSupported
namestringSupported

ValueSet

NameTypeLevel
codetokenSupported
contexttokenSupported
descriptionstringSupported
identifiertokenSupported
namestringSupported
titlestringSupported

MessageHeader

NameTypeLevel
codetokenSupported
destinationstringSupported
destination-uriuriSupported
focusreferenceSupported
senderreferenceSupported
sourcestringSupported
source-uriuriSupported

Subscription

NameTypeLevel
contacttokenSupported
criteriastringSupported
statustokenSupported
typetokenSupported
urluriSupported

CapabilityStatement

NameTypeLevel
descriptionstringSupported
formattokenSupported
modetokenSupported
namestringSupported
resourcetokenSupported
resource-profilereferenceSupported
titlestringSupported

Task

NameTypeLevel
based-onreferenceSupported
business-statustokenSupported
codetokenSupported
focusreferenceSupported
modifieddateSupported
ownerreferenceSupported
subjectreferenceSupported
performertokenSupported
perioddateSupported
prioritytokenSupported
requesterreferenceSupported
statustokenSupported

ServiceRequest

NameTypeLevel
based-onreferenceSupported
categorytokenSupported
codetokenSupported
identifiertokenSupported
intenttokenSupported
subjectreferenceSupported
performerreferenceSupported
performer-typetokenSupported
prioritytokenSupported
replacesreferenceSupported
requesterreferenceSupported
specimenreferenceSupported
statustokenSupported

PractitionerRole

NameTypeLevel
endpointreferenceSupported
identifiertokenSupported
organizationreferenceSupported
practitionerreferenceSupported
specialtytokenSupported
telecomtokenSupported

Practitioner

NameTypeLevel
namestringSupported
identifiertokenSupported

Organization

NameTypeLevel
addressstringSupported
endpointreferenceSupported
identifiertokenSupported
namestringSupported
partofreferenceSupported
typetokenSupported

DiagnosticReport

NameTypeLevel
based-onreferenceSupported
categorytokenSupported
codetokenSupported
conclusiontokenSupported
datedateSupported
identifiertokenSupported
issueddateSupported
subjectreferenceSupported
performerreferenceSupported
resultreferenceSupported
results-interpreterreferenceSupported
specimenreferenceSupported
statustokenSupported

FamilyMemberHistory

NameTypeLevel
codetokenSupported
datedateSupported
identifiertokenSupported
patientreferenceSupported
relationshiptokenSupported
sextokenSupported
statustokenSupported

Observation

NameTypeLevel
based-onreferenceSupported
categorytokenSupported
codetokenSupported
component-codetokenSupported
data-absent-reasontokenSupported
datedateSupported
focusreferenceSupported
identifiertokenSupported
subjectreferenceSupported
performerreferenceSupported
specimenreferenceSupported
value-stringstringSupported
statustokenSupported

Patient

NameTypeLevel
addressstringSupported
birthdatedateSupported
death-datetokenSupported
gendertokenSupported
general-practitionerreferenceSupported
identifiertokenSupported
linkreferenceSupported
namestringSupported
organizationreferenceSupported
telecomtokenSupported

Consent

NameTypeLevel
actiontokenSupported
actorreferenceSupported
categorytokenSupported
consentorreferenceSupported
identifiertokenSupported
organizationreferenceSupported
patientreferenceSupported
perioddateSupported

Condition

NameTypeLevel
asserterreferenceSupported
categorytokenSupported
clinical-statustokenSupported
codetokenSupported
identifiertokenSupported
onset-infostringSupported
subjectreferenceSupported
recorded-datedateSupported
severitytokenSupported
stagetokenSupported
verification-statustokenSupported

ResearchSubject

No search parameters are stated for this resource type

RelatedPerson

NameTypeLevel
patientreferenceSupported
relationshiptokenSupported

Specimen

NameTypeLevel
accessiontokenSupported
bodysitetokenSupported
collecteddateSupported
collectorreferenceSupported
container-idtokenSupported
identifiertokenSupported
parentreferenceSupported
subjectreferenceSupported
statustokenSupported
typetokenSupported

Questionnaire

NameTypeLevel
datedateSupported
descriptionstringSupported
effectivedateSupported
identifiertokenSupported
namestringSupported
statustokenSupported
titlestringSupported
versiontokenSupported

QuestionnaireResponse

NameTypeLevel
authorreferenceSupported
authoreddateSupported
identifiertokenSupported
subjectreferenceSupported
questionnairereferenceSupported
sourcereferenceSupported
statustokenSupported

OperationDefinition

No search parameters are stated for this resource type

OperationOutcome

No search parameters are stated for this resource type

BodyStructure

NameTypeLevel
identifiertokenSupported
locationtokenSupported
morphologytokenSupported
patientreferenceSupported

Provenance

NameTypeLevel
agentreferenceSupported
entityreferenceSupported
targetreferenceSupported
recordeddateSupported

Messaging Capabilities

ProtocolAddress
HTTPhttps://[baseUrl]/$process-message
Documentation

Endpoint which accepts test order and result message bundles. The server saves the whole message as well as splitting the message into its individual resources for ease of updating through RESTful interactions

ModeSupported Message
ReceiverMessageDefinition
Receivergenomictestresponse