Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
Examples
AuditEvent-patient-flag-Example
Important: This page is under development by NHS England
Tree View
AuditEvent |
id : PARS-AuditEvent-patient-flag-Example |
type |
system : http://terminology.hl7.org/CodeSystem/audit-event-type |
code : rest |
subtype |
system : http://hl7.org/fhir/restful-interaction |
code : read |
action : R |
recorded : 2024-07-01T09:49:00+00:00 |
agent |
who |
type : Organization |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : ABC |
display : A GP Surgery |
requestor : True |
agent |
who |
type : Endpoint |
identifier |
system : https://fhir.nhs.uk/Id/product-id |
value : patient-flag |
display : A GP Surgery |
requestor : False |
source |
site : https://api.service.nhs.uk/patient-flags-api |
observer |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 12345 |
display : Spine Demographics |
type |
system : http://terminology.hl7.org/CodeSystem/security-source-type |
code : 2 |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/nhs-number |
value : 9999999991 |
type |
system : http://terminology.hl7.org/CodeSystem/audit-entity-type |
code : 1 |
display : Person |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 1 |
display : Patient |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/transaction |
value : 76d148b6-586d-11ec-bf63-0242ac130082 |
type |
system : https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
code : XrequestId |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/product-id |
value : patient-flag |
type |
system : http://hl7.org/fhir/resource-types |
code : Endpoint |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 17 |
display : Data Repository |
name : Personnel Demographics Service |
detail |
type : productIdentifier |
value : Patient Flags |
detail |
type : interactionIdentifier |
value : Patient Flags - Get patient flags |
Table View
AuditEvent.id[0] | PARS-AuditEvent-patient-flag-Example |
AuditEvent.type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-event-type |
AuditEvent.type[0].code[0] | rest |
AuditEvent.subtype[0].system[0] | http://hl7.org/fhir/restful-interaction |
AuditEvent.subtype[0].code[0] | read |
AuditEvent.action[0] | R |
AuditEvent.recorded[0] | 2024-07-01T09:49:00+00:00 |
AuditEvent.agent[0].who[0].type[0] | Organization |
AuditEvent.agent[0].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
AuditEvent.agent[0].who[0].identifier[0].value[0] | ABC |
AuditEvent.agent[0].who[0].display[0] | A GP Surgery |
AuditEvent.agent[0].requestor[0] | True |
AuditEvent.agent[1].who[0].type[0] | Endpoint |
AuditEvent.agent[1].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/product-id |
AuditEvent.agent[1].who[0].identifier[0].value[0] | patient-flag |
AuditEvent.agent[1].who[0].display[0] | A GP Surgery |
AuditEvent.agent[1].requestor[0] | False |
AuditEvent.source[0].site[0] | https://api.service.nhs.uk/patient-flags-api |
AuditEvent.source[0].observer[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.source[0].observer[0].identifier[0].value[0] | 12345 |
AuditEvent.source[0].observer[0].display[0] | Spine Demographics |
AuditEvent.source[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/security-source-type |
AuditEvent.source[0].type[0].code[0] | 2 |
AuditEvent.entity[0].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
AuditEvent.entity[0].what[0].identifier[0].value[0] | 9999999991 |
AuditEvent.entity[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-entity-type |
AuditEvent.entity[0].type[0].code[0] | 1 |
AuditEvent.entity[0].type[0].display[0] | Person |
AuditEvent.entity[0].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[0].role[0].code[0] | 1 |
AuditEvent.entity[0].role[0].display[0] | Patient |
AuditEvent.entity[1].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/transaction |
AuditEvent.entity[1].what[0].identifier[0].value[0] | 76d148b6-586d-11ec-bf63-0242ac130082 |
AuditEvent.entity[1].type[0].system[0] | https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
AuditEvent.entity[1].type[0].code[0] | XrequestId |
AuditEvent.entity[2].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/product-id |
AuditEvent.entity[2].what[0].identifier[0].value[0] | patient-flag |
AuditEvent.entity[2].type[0].system[0] | http://hl7.org/fhir/resource-types |
AuditEvent.entity[2].type[0].code[0] | Endpoint |
AuditEvent.entity[2].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[2].role[0].code[0] | 17 |
AuditEvent.entity[2].role[0].display[0] | Data Repository |
AuditEvent.entity[2].name[0] | Personnel Demographics Service |
AuditEvent.entity[2].detail[0].type[0] | productIdentifier |
AuditEvent.entity[2].detail[0].value[0] | Patient Flags |
AuditEvent.entity[2].detail[1].type[0] | interactionIdentifier |
AuditEvent.entity[2].detail[1].value[0] | Patient Flags - Get patient flags |
XML View
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="PARS-AuditEvent-patient-flag-Example" /> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> </type> <subtype> <system value="http://hl7.org/fhir/restful-interaction" /> <code value="read" /> </subtype> <action value="R" /> <recorded value="2024-07-01T09:49:00+00:00" /> <agent> <who> <type value="Organization" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="ABC" /> </identifier> <display value="A GP Surgery" /> </who> <requestor value="true" /> </agent> <agent> <who> <type value="Endpoint" /> <identifier> <system value="https://fhir.nhs.uk/Id/product-id" /> <value value="patient-flag" /> </identifier> <display value="A GP Surgery" /> </who> <requestor value="false" /> </agent> <source> <site value="https://api.service.nhs.uk/patient-flags-api" /> <observer> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="12345" /> </identifier> <display value="Spine Demographics" /> </observer> <type> <system value="http://terminology.hl7.org/CodeSystem/security-source-type" /> <code value="2" /> </type> </source> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9999999991" /> </identifier> </what> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type" /> <code value="1" /> <display value="Person" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="1" /> <display value="Patient" /> </role> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/transaction" /> <value value="76d148b6-586d-11ec-bf63-0242ac130082" /> </identifier> </what> <type> <system value="https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType" /> <code value="XrequestId" /> </type> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/product-id" /> <value value="patient-flag" /> </identifier> </what> <type> <system value="http://hl7.org/fhir/resource-types" /> <code value="Endpoint" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="17" /> <display value="Data Repository" /> </role> <name value="Personnel Demographics Service" /> <detail> <type value="productIdentifier" /> <valueString value="Patient Flags" /> </detail> <detail> <type value="interactionIdentifier" /> <valueString value="Patient Flags - Get patient flags" /> </detail> </entity> </AuditEvent>
JSON View
{ "resourceType": "AuditEvent", "id": "PARS-AuditEvent-patient-flag-Example", "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest" }, "subtype": [ { "system": "http://hl7.org/fhir/restful-interaction", "code": "read" } ], "action": "R", "recorded": "2024-07-01T09:49:00+00:00", "agent": [ { "who": { "type": "Organization", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "ABC" }, "display": "A GP Surgery" }, "requestor": true }, { "who": { "type": "Endpoint", "identifier": { "system": "https://fhir.nhs.uk/Id/product-id", "value": "patient-flag" }, "display": "A GP Surgery" }, "requestor": false } ], "source": { "site": "https://api.service.nhs.uk/patient-flags-api", "observer": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "12345" }, "display": "Spine Demographics" }, "type": [ { "system": "http://terminology.hl7.org/CodeSystem/security-source-type", "code": "2" } ] }, "entity": [ { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999991" } }, "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type", "code": "1", "display": "Person" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "1", "display": "Patient" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/transaction", "value": "76d148b6-586d-11ec-bf63-0242ac130082" } }, "type": { "system": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType", "code": "XrequestId" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/product-id", "value": "patient-flag" } }, "type": { "system": "http://hl7.org/fhir/resource-types", "code": "Endpoint" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "17", "display": "Data Repository" }, "name": "Personnel Demographics Service", "detail": [ { "type": "productIdentifier", "valueString": "Patient Flags" }, { "type": "interactionIdentifier", "valueString": "Patient Flags - Get patient flags" } ] } ] }
AuditEvent-app-restricted-fhir-pds-read-Example
Important: This page is under development by NHS England
Tree View
AuditEvent |
id : PARS-AuditEvent-app-restricted-fhir-pds-read-Example |
type |
system : http://terminology.hl7.org/CodeSystem/audit-event-type |
code : rest |
subtype |
system : http://hl7.org/fhir/restful-interaction |
code : read |
action : R |
recorded : 2024-07-01T09:49:00+00:00 |
agent |
who |
type : Organization |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : ABC |
display : A GP Surgery |
requestor : True |
agent |
who |
type : Endpoint |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 9885632 |
display : A GP Surgery |
requestor : False |
source |
site : api.service.nhs.uk/personal-demographics/FHIR/R4/ |
observer |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 12345 |
display : Spine Demographics |
type |
system : http://terminology.hl7.org/CodeSystem/security-source-type |
code : 2 |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/nhs-number |
value : 9999999991 |
type |
system : http://terminology.hl7.org/CodeSystem/audit-entity-type |
code : 1 |
display : Person |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 1 |
display : Patient |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/transaction |
value : 76d148b6-586d-11ec-bf63-0242ac130082 |
type |
system : https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
code : XrequestId |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 123445 |
type |
system : http://hl7.org/fhir/resource-types |
code : Endpoint |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 17 |
display : Data Repository |
name : Personnel Demographics Service |
detail |
type : productIdentifier |
value : PDS |
detail |
type : interactionIdentifier |
value : PDS Retrieval Query |
Table View
AuditEvent.id[0] | PARS-AuditEvent-app-restricted-fhir-pds-read-Example |
AuditEvent.type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-event-type |
AuditEvent.type[0].code[0] | rest |
AuditEvent.subtype[0].system[0] | http://hl7.org/fhir/restful-interaction |
AuditEvent.subtype[0].code[0] | read |
AuditEvent.action[0] | R |
AuditEvent.recorded[0] | 2024-07-01T09:49:00+00:00 |
AuditEvent.agent[0].who[0].type[0] | Organization |
AuditEvent.agent[0].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
AuditEvent.agent[0].who[0].identifier[0].value[0] | ABC |
AuditEvent.agent[0].who[0].display[0] | A GP Surgery |
AuditEvent.agent[0].requestor[0] | True |
AuditEvent.agent[1].who[0].type[0] | Endpoint |
AuditEvent.agent[1].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.agent[1].who[0].identifier[0].value[0] | 9885632 |
AuditEvent.agent[1].who[0].display[0] | A GP Surgery |
AuditEvent.agent[1].requestor[0] | False |
AuditEvent.source[0].site[0] | api.service.nhs.uk/personal-demographics/FHIR/R4/ |
AuditEvent.source[0].observer[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.source[0].observer[0].identifier[0].value[0] | 12345 |
AuditEvent.source[0].observer[0].display[0] | Spine Demographics |
AuditEvent.source[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/security-source-type |
AuditEvent.source[0].type[0].code[0] | 2 |
AuditEvent.entity[0].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
AuditEvent.entity[0].what[0].identifier[0].value[0] | 9999999991 |
AuditEvent.entity[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-entity-type |
AuditEvent.entity[0].type[0].code[0] | 1 |
AuditEvent.entity[0].type[0].display[0] | Person |
AuditEvent.entity[0].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[0].role[0].code[0] | 1 |
AuditEvent.entity[0].role[0].display[0] | Patient |
AuditEvent.entity[1].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/transaction |
AuditEvent.entity[1].what[0].identifier[0].value[0] | 76d148b6-586d-11ec-bf63-0242ac130082 |
AuditEvent.entity[1].type[0].system[0] | https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
AuditEvent.entity[1].type[0].code[0] | XrequestId |
AuditEvent.entity[2].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.entity[2].what[0].identifier[0].value[0] | 123445 |
AuditEvent.entity[2].type[0].system[0] | http://hl7.org/fhir/resource-types |
AuditEvent.entity[2].type[0].code[0] | Endpoint |
AuditEvent.entity[2].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[2].role[0].code[0] | 17 |
AuditEvent.entity[2].role[0].display[0] | Data Repository |
AuditEvent.entity[2].name[0] | Personnel Demographics Service |
AuditEvent.entity[2].detail[0].type[0] | productIdentifier |
AuditEvent.entity[2].detail[0].value[0] | PDS |
AuditEvent.entity[2].detail[1].type[0] | interactionIdentifier |
AuditEvent.entity[2].detail[1].value[0] | PDS Retrieval Query |
XML View
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="PARS-AuditEvent-app-restricted-fhir-pds-read-Example" /> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> </type> <subtype> <system value="http://hl7.org/fhir/restful-interaction" /> <code value="read" /> </subtype> <action value="R" /> <recorded value="2024-07-01T09:49:00+00:00" /> <agent> <who> <type value="Organization" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="ABC" /> </identifier> <display value="A GP Surgery" /> </who> <requestor value="true" /> </agent> <agent> <who> <type value="Endpoint" /> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="9885632" /> </identifier> <display value="A GP Surgery" /> </who> <requestor value="false" /> </agent> <source> <site value="api.service.nhs.uk/personal-demographics/FHIR/R4/" /> <observer> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="12345" /> </identifier> <display value="Spine Demographics" /> </observer> <type> <system value="http://terminology.hl7.org/CodeSystem/security-source-type" /> <code value="2" /> </type> </source> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9999999991" /> </identifier> </what> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type" /> <code value="1" /> <display value="Person" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="1" /> <display value="Patient" /> </role> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/transaction" /> <value value="76d148b6-586d-11ec-bf63-0242ac130082" /> </identifier> </what> <type> <system value="https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType" /> <code value="XrequestId" /> </type> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="123445" /> </identifier> </what> <type> <system value="http://hl7.org/fhir/resource-types" /> <code value="Endpoint" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="17" /> <display value="Data Repository" /> </role> <name value="Personnel Demographics Service" /> <detail> <type value="productIdentifier" /> <valueString value="PDS" /> </detail> <detail> <type value="interactionIdentifier" /> <valueString value="PDS Retrieval Query" /> </detail> </entity> </AuditEvent>
JSON View
{ "resourceType": "AuditEvent", "id": "PARS-AuditEvent-app-restricted-fhir-pds-read-Example", "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest" }, "subtype": [ { "system": "http://hl7.org/fhir/restful-interaction", "code": "read" } ], "action": "R", "recorded": "2024-07-01T09:49:00+00:00", "agent": [ { "who": { "type": "Organization", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "ABC" }, "display": "A GP Surgery" }, "requestor": true }, { "who": { "type": "Endpoint", "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "9885632" }, "display": "A GP Surgery" }, "requestor": false } ], "source": { "site": "api.service.nhs.uk/personal-demographics/FHIR/R4/", "observer": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "12345" }, "display": "Spine Demographics" }, "type": [ { "system": "http://terminology.hl7.org/CodeSystem/security-source-type", "code": "2" } ] }, "entity": [ { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999991" } }, "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type", "code": "1", "display": "Person" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "1", "display": "Patient" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/transaction", "value": "76d148b6-586d-11ec-bf63-0242ac130082" } }, "type": { "system": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType", "code": "XrequestId" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "123445" } }, "type": { "system": "http://hl7.org/fhir/resource-types", "code": "Endpoint" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "17", "display": "Data Repository" }, "name": "Personnel Demographics Service", "detail": [ { "type": "productIdentifier", "valueString": "PDS" }, { "type": "interactionIdentifier", "valueString": "PDS Retrieval Query" } ] } ] }
AuditEvent-patient-restricted-fhir-pds-update-Example
Important: This page is under development by NHS England
Tree View
AuditEvent |
id : PARS-AuditEvent-patient-restricted-fhir-pds-update-Example |
type |
system : http://terminology.hl7.org/CodeSystem/audit-event-type |
code : rest |
display : Restful Operation |
subtype |
system : http://hl7.org/fhir/restful-interaction |
code : patch |
action : U |
recorded : 2024-07-01T09:49:00+00:00 |
agent |
who |
type : Organization |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : X26 |
display : NHS App |
requestor : True |
agent |
who |
type : Patient |
identifier |
system : https://fhir.nhs.uk/Id/nhs-number |
value : 9999999991 |
requestor : True |
source |
site : api.service.nhs.uk/personal-demographics/FHIR/R4/ |
observer |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 12345 |
display : Spine Demographics |
type |
system : http://terminology.hl7.org/CodeSystem/security-source-type |
code : 1 |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/nhs-number |
value : 9999999991 |
type |
system : http://terminology.hl7.org/CodeSystem/audit-entity-type |
code : 1 |
display : Person |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 1 |
display : Patient |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/transaction |
value : 87d148b6-586d-11ec-bf63-0242ac130002 |
type |
system : https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
code : XrequestId |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 123445 |
type |
system : http://hl7.org/fhir/resource-types |
code : Endpoint |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 17 |
display : Data Repository |
name : Personnel Demographics Service |
detail |
type : productIdentifier |
value : PDS |
detail |
type : interactionIdentifier |
value : PDS Update |
Table View
AuditEvent.id[0] | PARS-AuditEvent-patient-restricted-fhir-pds-update-Example |
AuditEvent.type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-event-type |
AuditEvent.type[0].code[0] | rest |
AuditEvent.type[0].display[0] | Restful Operation |
AuditEvent.subtype[0].system[0] | http://hl7.org/fhir/restful-interaction |
AuditEvent.subtype[0].code[0] | patch |
AuditEvent.action[0] | U |
AuditEvent.recorded[0] | 2024-07-01T09:49:00+00:00 |
AuditEvent.agent[0].who[0].type[0] | Organization |
AuditEvent.agent[0].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
AuditEvent.agent[0].who[0].identifier[0].value[0] | X26 |
AuditEvent.agent[0].who[0].display[0] | NHS App |
AuditEvent.agent[0].requestor[0] | True |
AuditEvent.agent[1].who[0].type[0] | Patient |
AuditEvent.agent[1].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
AuditEvent.agent[1].who[0].identifier[0].value[0] | 9999999991 |
AuditEvent.agent[1].requestor[0] | True |
AuditEvent.source[0].site[0] | api.service.nhs.uk/personal-demographics/FHIR/R4/ |
AuditEvent.source[0].observer[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.source[0].observer[0].identifier[0].value[0] | 12345 |
AuditEvent.source[0].observer[0].display[0] | Spine Demographics |
AuditEvent.source[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/security-source-type |
AuditEvent.source[0].type[0].code[0] | 1 |
AuditEvent.entity[0].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
AuditEvent.entity[0].what[0].identifier[0].value[0] | 9999999991 |
AuditEvent.entity[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-entity-type |
AuditEvent.entity[0].type[0].code[0] | 1 |
AuditEvent.entity[0].type[0].display[0] | Person |
AuditEvent.entity[0].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[0].role[0].code[0] | 1 |
AuditEvent.entity[0].role[0].display[0] | Patient |
AuditEvent.entity[1].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/transaction |
AuditEvent.entity[1].what[0].identifier[0].value[0] | 87d148b6-586d-11ec-bf63-0242ac130002 |
AuditEvent.entity[1].type[0].system[0] | https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
AuditEvent.entity[1].type[0].code[0] | XrequestId |
AuditEvent.entity[2].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.entity[2].what[0].identifier[0].value[0] | 123445 |
AuditEvent.entity[2].type[0].system[0] | http://hl7.org/fhir/resource-types |
AuditEvent.entity[2].type[0].code[0] | Endpoint |
AuditEvent.entity[2].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[2].role[0].code[0] | 17 |
AuditEvent.entity[2].role[0].display[0] | Data Repository |
AuditEvent.entity[2].name[0] | Personnel Demographics Service |
AuditEvent.entity[2].detail[0].type[0] | productIdentifier |
AuditEvent.entity[2].detail[0].value[0] | PDS |
AuditEvent.entity[2].detail[1].type[0] | interactionIdentifier |
AuditEvent.entity[2].detail[1].value[0] | PDS Update |
XML View
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="PARS-AuditEvent-patient-restricted-fhir-pds-update-Example" /> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> <display value="Restful Operation" /> </type> <subtype> <system value="http://hl7.org/fhir/restful-interaction" /> <code value="patch" /> </subtype> <action value="U" /> <recorded value="2024-07-01T09:49:00+00:00" /> <agent> <who> <type value="Organization" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="X26" /> </identifier> <display value="NHS App" /> </who> <requestor value="true" /> </agent> <agent> <who> <type value="Patient" /> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9999999991" /> </identifier> </who> <requestor value="true" /> </agent> <source> <site value="api.service.nhs.uk/personal-demographics/FHIR/R4/" /> <observer> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="12345" /> </identifier> <display value="Spine Demographics" /> </observer> <type> <system value="http://terminology.hl7.org/CodeSystem/security-source-type" /> <code value="1" /> </type> </source> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9999999991" /> </identifier> </what> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type" /> <code value="1" /> <display value="Person" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="1" /> <display value="Patient" /> </role> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/transaction" /> <value value="87d148b6-586d-11ec-bf63-0242ac130002" /> </identifier> </what> <type> <system value="https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType" /> <code value="XrequestId" /> </type> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="123445" /> </identifier> </what> <type> <system value="http://hl7.org/fhir/resource-types" /> <code value="Endpoint" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="17" /> <display value="Data Repository" /> </role> <name value="Personnel Demographics Service" /> <detail> <type value="productIdentifier" /> <valueString value="PDS" /> </detail> <detail> <type value="interactionIdentifier" /> <valueString value="PDS Update" /> </detail> </entity> </AuditEvent>
JSON View
{ "resourceType": "AuditEvent", "id": "PARS-AuditEvent-patient-restricted-fhir-pds-update-Example", "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest", "display": "Restful Operation" }, "subtype": [ { "system": "http://hl7.org/fhir/restful-interaction", "code": "patch" } ], "action": "U", "recorded": "2024-07-01T09:49:00+00:00", "agent": [ { "who": { "type": "Organization", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "X26" }, "display": "NHS App" }, "requestor": true }, { "who": { "type": "Patient", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999991" } }, "requestor": true } ], "source": { "site": "api.service.nhs.uk/personal-demographics/FHIR/R4/", "observer": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "12345" }, "display": "Spine Demographics" }, "type": [ { "system": "http://terminology.hl7.org/CodeSystem/security-source-type", "code": "1" } ] }, "entity": [ { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999991" } }, "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type", "code": "1", "display": "Person" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "1", "display": "Patient" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/transaction", "value": "87d148b6-586d-11ec-bf63-0242ac130002" } }, "type": { "system": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType", "code": "XrequestId" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "123445" } }, "type": { "system": "http://hl7.org/fhir/resource-types", "code": "Endpoint" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "17", "display": "Data Repository" }, "name": "Personnel Demographics Service", "detail": [ { "type": "productIdentifier", "valueString": "PDS" }, { "type": "interactionIdentifier", "valueString": "PDS Update" } ] } ] }
AuditEvent-user-restricted-hl7v3-gpsummary-read-Example
Important: This page is under development by NHS England
Tree View
AuditEvent |
id : PARS-AuditEvent-user-restricted-hl7v3-gpsummary-read-Example |
type |
system : http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle |
code : transmit |
action : R |
recorded : 2024-07-01T09:49:00+00:00 |
agent |
who |
type : Organization |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : ABC |
display : A GP Surgery |
requestor : True |
agent |
who |
type : Practitioner |
identifier |
system : https://fhir.nhs.uk/Id/sds-user-id |
value : 123456 |
display : John Smith |
requestor : True |
source |
site : psis-umasync.national.ncrs.nhs.uk |
observer |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 12345 |
display : Spine Clinicals |
type |
system : http://terminology.hl7.org/CodeSystem/security-source-type |
code : 2 |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/nhs-number |
value : 9999999991 |
type |
system : http://terminology.hl7.org/CodeSystem/audit-entity-type |
code : 1 |
display : Person |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 1 |
display : Patient |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/transaction |
value : 123148b6-586d-11ec-bf63-0242ac130005 |
type |
system : https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
code : XrequestId |
entity |
what |
identifier |
system : https://fhir.nhs.uk/Id/accredited-system |
value : 123445 |
type |
system : http://hl7.org/fhir/resource-types |
code : Endpoint |
role |
system : http://terminology.hl7.org/CodeSystem/object-role |
code : 17 |
display : Data Repository |
name : Personnel Demographics Service |
detail |
type : productIdentifier |
value : GP Summary |
detail |
type : interactionIdentifier |
value : QUPC_IN190000UK04 |
Table View
AuditEvent.id[0] | PARS-AuditEvent-user-restricted-hl7v3-gpsummary-read-Example |
AuditEvent.type[0].system[0] | http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle |
AuditEvent.type[0].code[0] | transmit |
AuditEvent.action[0] | R |
AuditEvent.recorded[0] | 2024-07-01T09:49:00+00:00 |
AuditEvent.agent[0].who[0].type[0] | Organization |
AuditEvent.agent[0].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
AuditEvent.agent[0].who[0].identifier[0].value[0] | ABC |
AuditEvent.agent[0].who[0].display[0] | A GP Surgery |
AuditEvent.agent[0].requestor[0] | True |
AuditEvent.agent[1].who[0].type[0] | Practitioner |
AuditEvent.agent[1].who[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-user-id |
AuditEvent.agent[1].who[0].identifier[0].value[0] | 123456 |
AuditEvent.agent[1].who[0].display[0] | John Smith |
AuditEvent.agent[1].requestor[0] | True |
AuditEvent.source[0].site[0] | psis-umasync.national.ncrs.nhs.uk |
AuditEvent.source[0].observer[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.source[0].observer[0].identifier[0].value[0] | 12345 |
AuditEvent.source[0].observer[0].display[0] | Spine Clinicals |
AuditEvent.source[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/security-source-type |
AuditEvent.source[0].type[0].code[0] | 2 |
AuditEvent.entity[0].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
AuditEvent.entity[0].what[0].identifier[0].value[0] | 9999999991 |
AuditEvent.entity[0].type[0].system[0] | http://terminology.hl7.org/CodeSystem/audit-entity-type |
AuditEvent.entity[0].type[0].code[0] | 1 |
AuditEvent.entity[0].type[0].display[0] | Person |
AuditEvent.entity[0].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[0].role[0].code[0] | 1 |
AuditEvent.entity[0].role[0].display[0] | Patient |
AuditEvent.entity[1].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/transaction |
AuditEvent.entity[1].what[0].identifier[0].value[0] | 123148b6-586d-11ec-bf63-0242ac130005 |
AuditEvent.entity[1].type[0].system[0] | https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType |
AuditEvent.entity[1].type[0].code[0] | XrequestId |
AuditEvent.entity[2].what[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/accredited-system |
AuditEvent.entity[2].what[0].identifier[0].value[0] | 123445 |
AuditEvent.entity[2].type[0].system[0] | http://hl7.org/fhir/resource-types |
AuditEvent.entity[2].type[0].code[0] | Endpoint |
AuditEvent.entity[2].role[0].system[0] | http://terminology.hl7.org/CodeSystem/object-role |
AuditEvent.entity[2].role[0].code[0] | 17 |
AuditEvent.entity[2].role[0].display[0] | Data Repository |
AuditEvent.entity[2].name[0] | Personnel Demographics Service |
AuditEvent.entity[2].detail[0].type[0] | productIdentifier |
AuditEvent.entity[2].detail[0].value[0] | GP Summary |
AuditEvent.entity[2].detail[1].type[0] | interactionIdentifier |
AuditEvent.entity[2].detail[1].value[0] | QUPC_IN190000UK04 |
XML View
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="PARS-AuditEvent-user-restricted-hl7v3-gpsummary-read-Example" /> <type> <system value="http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle" /> <code value="transmit" /> </type> <action value="R" /> <recorded value="2024-07-01T09:49:00+00:00" /> <agent> <who> <type value="Organization" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="ABC" /> </identifier> <display value="A GP Surgery" /> </who> <requestor value="true" /> </agent> <agent> <who> <type value="Practitioner" /> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id" /> <value value="123456" /> </identifier> <display value="John Smith" /> </who> <requestor value="true" /> </agent> <source> <site value="psis-umasync.national.ncrs.nhs.uk" /> <observer> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="12345" /> </identifier> <display value="Spine Clinicals" /> </observer> <type> <system value="http://terminology.hl7.org/CodeSystem/security-source-type" /> <code value="2" /> </type> </source> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9999999991" /> </identifier> </what> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type" /> <code value="1" /> <display value="Person" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="1" /> <display value="Patient" /> </role> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/transaction" /> <value value="123148b6-586d-11ec-bf63-0242ac130005" /> </identifier> </what> <type> <system value="https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType" /> <code value="XrequestId" /> </type> </entity> <entity> <what> <identifier> <system value="https://fhir.nhs.uk/Id/accredited-system" /> <value value="123445" /> </identifier> </what> <type> <system value="http://hl7.org/fhir/resource-types" /> <code value="Endpoint" /> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role" /> <code value="17" /> <display value="Data Repository" /> </role> <name value="Personnel Demographics Service" /> <detail> <type value="productIdentifier" /> <valueString value="GP Summary" /> </detail> <detail> <type value="interactionIdentifier" /> <valueString value="QUPC_IN190000UK04" /> </detail> </entity> </AuditEvent>
JSON View
{ "resourceType": "AuditEvent", "id": "PARS-AuditEvent-user-restricted-hl7v3-gpsummary-read-Example", "type": { "system": "http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle", "code": "transmit" }, "action": "R", "recorded": "2024-07-01T09:49:00+00:00", "agent": [ { "who": { "type": "Organization", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "ABC" }, "display": "A GP Surgery" }, "requestor": true }, { "who": { "type": "Practitioner", "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "123456" }, "display": "John Smith" }, "requestor": true } ], "source": { "site": "psis-umasync.national.ncrs.nhs.uk", "observer": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "12345" }, "display": "Spine Clinicals" }, "type": [ { "system": "http://terminology.hl7.org/CodeSystem/security-source-type", "code": "2" } ] }, "entity": [ { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999991" } }, "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type", "code": "1", "display": "Person" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "1", "display": "Patient" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/transaction", "value": "123148b6-586d-11ec-bf63-0242ac130005" } }, "type": { "system": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType", "code": "XrequestId" } }, { "what": { "identifier": { "system": "https://fhir.nhs.uk/Id/accredited-system", "value": "123445" } }, "type": { "system": "http://hl7.org/fhir/resource-types", "code": "Endpoint" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "17", "display": "Data Repository" }, "name": "Personnel Demographics Service", "detail": [ { "type": "productIdentifier", "valueString": "GP Summary" }, { "type": "interactionIdentifier", "valueString": "QUPC_IN190000UK04" } ] } ] }