Skip to content

NPA-5431: Updated OAS and examples with new meta field for security tag #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ellie-bound1-NHSD merged 1 commit into from
Aug 27, 2025
Merged

NPA-5431: Updated OAS and examples with new meta field for security tag #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .../examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000009"
Expand Down Expand Up @@ -138,6 +143,11 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
resource:
resourceType: Patient
id: DFCC67F5
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000005"
Expand Down
15 changes: 15 additions & 0 deletions specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ ConsentMultipleRelationshipsIncludePatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000009'
Expand Down Expand Up @@ -92,6 +97,11 @@ ConsentMultipleRelationshipsIncludePatientBundle:
resource:
resourceType: Patient
id: DFCC67F5
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
Expand Down Expand Up @@ -166,6 +176,11 @@ ConsentMultipleRelationshipsIncludePatientBundle:
resource:
resourceType: Patient
id: ZPTT32T3
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000006'
Expand Down
15 changes: 15 additions & 0 deletions ...tion/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000009'
Expand Down Expand Up @@ -139,6 +144,11 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: DFCC67F5
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
Expand Down Expand Up @@ -235,6 +245,11 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: ZPTT32T3
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000006'
Expand Down
5 changes: 5 additions & 0 deletions ...examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000100'
Expand Down
5 changes: 5 additions & 0 deletions ...esponses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000100'
Expand Down
5 changes: 5 additions & 0 deletions .../examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle:
resource:
resourceType: Patient
id: DFCC67F5
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
Expand Down
5 changes: 5 additions & 0 deletions ...responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: DFCC67F5
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000005'
Expand Down
5 changes: 5 additions & 0 deletions ...tion/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000009'
Expand Down
5 changes: 5 additions & 0 deletions ...les/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
resource:
resourceType: Patient
id: A3CC67E2
meta:
security:
- system: "https://fhir.nhs.uk/CodeSystem/NHSIdentityProofingLevel"
code: "P9"
display: "High level verification (P9)"
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000009'
Expand Down
12 changes: 12 additions & 0 deletions specification/validated-relationships-service-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2185,6 +2185,8 @@ components:
id:
type: string
description: Unique identifier of the Patient resource
meta:
$ref: "#/components/schemas/Meta"
identifier:
type: array
description: The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).
Expand Down Expand Up @@ -2433,6 +2435,16 @@ components:
type: string
description: "The value that is unique."

Meta:
type: object
description: Metadata about a resource
properties:
security:
type: array
description: Security Labels applied a resource
items:
$ref: "#/components/schemas/Coding"

CodeableConcept:
type: object
properties:
Expand Down