UK Core Implementation Guide Assets in Development

Please note:

This is an Implementation Guide for UK Core FHIR Assets in Development.
There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
Therefore this Implementation Guide must not be implemented.
Please follow the guidance on the "Contact Us" page if you need any assistance.

Example to illustrate an event made for purposes of maintaining a security log for a query search.

Table View

AuditEvent.id[0]	UKCore-AuditEvent-Query-Example
AuditEvent.type[0].system[0]	http://dicom.nema.org/resources/ontology/DCM
AuditEvent.type[0].code[0]	110112
AuditEvent.type[0].display[0]	Query
AuditEvent.subtype[0].system[0]	http://hl7.org/fhir/restful-interaction
AuditEvent.subtype[0].code[0]	search
AuditEvent.subtype[0].display[0]	search
AuditEvent.recorded[0]	2020-12-10T13:10:00+00:00
AuditEvent.agent[0].role[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
AuditEvent.agent[0].role[0].coding[0].code[0]	RESPRSN
AuditEvent.agent[0].role[0].coding[0].display[0]	responsible party
AuditEvent.agent[0].who[0].reference[0]	Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
AuditEvent.agent[0].requestor[0]	True
AuditEvent.agent[0].location[0].reference[0]	Location/UKCore-Location-CardiologySJUH-Example
AuditEvent.source[0].observer[0].reference[0]	Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example
AuditEvent.source[0].type[0].system[0]	http://terminology.hl7.org/CodeSystem/security-source-type
AuditEvent.source[0].type[0].code[0]	1
AuditEvent.source[0].type[0].display[0]	User Device
AuditEvent.entity[0].what[0].reference[0]	Patient/UKCore-Patient-RichardSmith-Example
AuditEvent.entity[0].type[0].system[0]	http://hl7.org/fhir/resource-types
AuditEvent.entity[0].type[0].code[0]	Patient
AuditEvent.entity[0].type[0].display[0]	Patient

XML View

<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="UKCore-AuditEvent-Query-Example" />
    <type>
        <system value="http://dicom.nema.org/resources/ontology/DCM" />
        <code value="110112" />
        <display value="Query" />
    </type>
    <subtype>
        <system value="http://hl7.org/fhir/restful-interaction" />
        <code value="search" />
        <display value="search" />
    </subtype>
    <recorded value="2020-12-10T13:10:00+00:00" />
    <agent>
        <role>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                <code value="RESPRSN" />
                <display value="responsible party" />
            </coding>
        </role>
        <who>
            <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
        </who>
        <requestor value="true" />
        <location>
            <reference value="Location/UKCore-Location-CardiologySJUH-Example" />
        </location>
    </agent>
    <source>
        <observer>
            <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" />
        </observer>
        <type>
            <system value="http://terminology.hl7.org/CodeSystem/security-source-type" />
            <code value="1" />
            <display value="User Device" />
        </type>
    </source>
    <entity>
        <what>
            <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        </what>
        <type>
            <system value="http://hl7.org/fhir/resource-types" />
            <code value="Patient" />
            <display value="Patient" />
        </type>
    </entity>
</AuditEvent>

JSON View

{
    "resourceType": "AuditEvent",
    "id": "UKCore-AuditEvent-Query-Example",
    "type": {
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "code": "110112",
        "display": "Query"
    },
    "subtype":  [
        {
            "system": "http://hl7.org/fhir/restful-interaction",
            "code": "search",
            "display": "search"
        }
    ],
    "recorded": "2020-12-10T13:10:00+00:00",
    "agent":  [
        {
            "role":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                            "code": "RESPRSN",
                            "display": "responsible party"
                        }
                    ]
                }
            ],
            "who": {
                "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
            },
            "requestor": true,
            "location": {
                "reference": "Location/UKCore-Location-CardiologySJUH-Example"
            }
        }
    ],
    "source": {
        "observer": {
            "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example"
        },
        "type":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
                "code": "1",
                "display": "User Device"
            }
        ]
    },
    "entity":  [
        {
            "what": {
                "reference": "Patient/UKCore-Patient-RichardSmith-Example"
            },
            "type": {
                "system": "http://hl7.org/fhir/resource-types",
                "code": "Patient",
                "display": "Patient"
            }
        }
    ]
}