Skip to content

Commit 380ba95

Browse files
authored
Merge pull request #247 from NHSDigital/Feature-IOPS-3735-UGR-Capabilities
[IOPS-3735] Example CapabilityStatement for UGR
2 parents ae4c566 + 6e470bd commit 380ba95

2 files changed

Lines changed: 212 additions & 3 deletions

File tree

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
{
2+
"resourceType": "CapabilityStatement",
3+
"id": "CapabilityStatement-UGR-application",
4+
"url": "https://fhir.nhs.uk/CapabilityStatement/UGR-application",
5+
"version": "0.1.0",
6+
"name": "CapabilityStatementUGRApplication",
7+
"status": "draft",
8+
"date": "2026-07-08T00:00:00+00:00",
9+
"publisher": "NHS England",
10+
"description": "Sample server capability for the Unified Genomic Record",
11+
"kind": "instance",
12+
"implementationGuide": [
13+
"https://fhir.nhs.uk/ImplementationGuide/FHIR-Genomics-Implementation-Guide"
14+
],
15+
"fhirVersion": "4.0.1",
16+
"format": [
17+
"application/fhir+json"
18+
],
19+
"implementation": {
20+
"description": "Exemplar CapabilityStatement for the GMS Unified Genomic Record, covering the resources required for developing the UGR composition. Capabilities for managing clinical resources are expected to follow SPR/GOMS capabilities"
21+
},
22+
"rest": [
23+
{
24+
"mode": "server",
25+
"documentation": "RESTful endpoints supported by the UGR FHIR API",
26+
"resource": [
27+
{
28+
"type": "Composition",
29+
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-Composition-GenomicsEULabReport",
30+
"documentation": "For searching and retrieving Compositions and generating UGR Documents",
31+
"interaction": [
32+
{
33+
"code": "read"
34+
},
35+
{
36+
"code": "search-type"
37+
},
38+
{
39+
"code": "vread"
40+
},
41+
{
42+
"code": "history-instance"
43+
}
44+
],
45+
"searchParam": [
46+
{
47+
"name": "type",
48+
"type": "token"
49+
},
50+
{
51+
"name": "subject",
52+
"type": "reference"
53+
},
54+
{
55+
"name": "entry",
56+
"type": "reference"
57+
},
58+
{
59+
"name": "date",
60+
"type": "date"
61+
}
62+
],
63+
"versioning": "versioned",
64+
"readHistory": true,
65+
"operation": [
66+
{
67+
"name": "$document",
68+
"definition": "http://hl7.org/fhir/OperationDefinition/Composition-document"
69+
}
70+
]
71+
},
72+
{
73+
"type": "RelatedPerson",
74+
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-RelatedPerson-Genomics",
75+
"documentation": "Endpoints for interacting with RelatedPerson resources to link UGRs",
76+
"interaction": [
77+
{
78+
"code": "read"
79+
},
80+
{
81+
"code": "vread"
82+
},
83+
{
84+
"code": "update"
85+
},
86+
{
87+
"code": "patch"
88+
},
89+
{
90+
"code": "delete"
91+
},
92+
{
93+
"code": "history-instance"
94+
},
95+
{
96+
"code": "create"
97+
},
98+
{
99+
"code": "search-type"
100+
}
101+
],
102+
"versioning": "versioned",
103+
"readHistory": true,
104+
"conditionalCreate": true,
105+
"referencePolicy": [
106+
"resolves"
107+
],
108+
"searchParam": [
109+
{
110+
"name": "active",
111+
"type": "token"
112+
},
113+
{
114+
"name": "identifier",
115+
"type": "token"
116+
},
117+
{
118+
"name": "patient",
119+
"type": "reference"
120+
},
121+
{
122+
"name": "relationship",
123+
"type": "token"
124+
}
125+
]
126+
},
127+
{
128+
"type": "Consent",
129+
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-Consent-GenomicsPCF",
130+
"documentation": "Endpoints for interacting with Consent resources representing data access permissions for UGRs",
131+
"interaction": [
132+
{
133+
"code": "read"
134+
},
135+
{
136+
"code": "vread"
137+
},
138+
{
139+
"code": "update"
140+
},
141+
{
142+
"code": "patch"
143+
},
144+
{
145+
"code": "delete"
146+
},
147+
{
148+
"code": "history-instance"
149+
},
150+
{
151+
"code": "create"
152+
},
153+
{
154+
"code": "search-type"
155+
}
156+
],
157+
"versioning": "versioned",
158+
"readHistory": true,
159+
"conditionalCreate": true,
160+
"referencePolicy": [
161+
"resolves"
162+
],
163+
"searchParam": [
164+
{
165+
"name": "action",
166+
"type": "token"
167+
},
168+
{
169+
"name": "actor",
170+
"type": "reference"
171+
},
172+
{
173+
"name": "category",
174+
"type": "token"
175+
},
176+
{
177+
"name": "consentor",
178+
"type": "reference"
179+
},
180+
{
181+
"name": "data",
182+
"type": "reference"
183+
},
184+
{
185+
"name": "patient",
186+
"type": "reference"
187+
},
188+
{
189+
"name": "period",
190+
"type": "date"
191+
},
192+
{
193+
"name": "purpose",
194+
"type": "token"
195+
},
196+
{
197+
"name": "scope",
198+
"type": "token"
199+
},
200+
{
201+
"name": "status",
202+
"type": "token"
203+
}
204+
]
205+
}
206+
]
207+
}
208+
]
209+
}

CapabilityStatement/CapabilityStatement-genomics-application.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"resourceType": "CapabilityStatement",
33
"id": "CapabilityStatement-Genomics-application",
44
"url": "https://fhir.nhs.uk/CapabilityStatement/genomics-application",
5-
"version": "0.2.0",
5+
"version": "0.3.0",
66
"name": "CapabilityStatementGenomicsApplication",
77
"status": "draft",
8-
"date": "2024-08-09T00:00:00+00:00",
8+
"date": "2026-07-08T00:00:00+00:00",
99
"publisher": "NHS England",
1010
"description": "Sample server capability for the Genomic Medicine Service",
1111
"kind": "instance",
@@ -1870,7 +1870,7 @@
18701870
},
18711871
{
18721872
"type": "RequestGroup",
1873-
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-RelatedPerson-Genomics",
1873+
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-RequestGroup-Genomics",
18741874
"documentation": "For searching group/family test request.",
18751875
"interaction": [
18761876
{

0 commit comments

Comments
 (0)