FHIR Genomics Implementation Guide

Notice

Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.

StructureDefinition AuditEvent

Created by the central GMS infrastructure on any CRUD event.

Can be searched on for auditability and obtaining status history for Tasks (as an alternative to the Task _history option).

It is not expected or permitted that a client system would update or post AuditEvents to the central service.

AuditEvents are expected to be created for any CRUD events which affect resources on the server. Where resources do not exist on the server, e.g. empty SearchSets or failed POSTs, no AuditEvents will be created. Failed updates may still trigger creation of AuditEvent resources but the outcome.code will record that the event was unsuccessful.

AuditEvents for resources created by the server will record the server identity within the who element.

The below profile is therefore provided to support parsing for clients if returned through a GET request.

Profile url	FHIR Module	Normative Status
http://hl7.org/fhir/StructureDefinition/AuditEvent	HL7 International	trial-use

AuditEvent	I		DomainResource	Element id AuditEvent Short description Event record kept for security purposes Definition A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Comments Based on IHE-ATNA. Data type DomainResource Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act workflow: Event rim: ControlAct[moodCode=EVN] dicom: Message
id	Σ	0..1	string	There are no (further) constraints on this element Element id AuditEvent.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id AuditEvent.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id AuditEvent.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id AuditEvent.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id AuditEvent.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id AuditEvent.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
type	Σ	1..1	CodingBinding	Element id AuditEvent.type Short description Type/identifier of event Definition Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. Requirements This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Binding Type of event. AuditEventID (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding workflow: Event.code w5: FiveWs.what[x] rim: .code (type, subtype and action are pre-coordinated or sent as translations) dicom: EventId w3c.prov: Activity
subtype	Σ	0..*	CodingBinding	Element id AuditEvent.subtype Short description More specific type/id for the event Definition Identifier for the category of event. Requirements This field enables queries of messages by implementation-defined event categories. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Binding Sub-type of event. AuditEventSub-Type (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.what[x] rim: .code (type, subtype and action are pre-coordinated or sent as translations) dicom: EventTypeCode
action	Σ	0..1	codeBinding	Element id AuditEvent.action Short description Type of action performed during the event Definition Indicator for type of action performed during the event that generated the audit. Requirements This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Indicator for type of action performed during the event that generated the event. AuditEventAction (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] rim: .code (type, subtype and action are pre-coordinated or sent as translations) dicom: EventActionCode
period	I	0..1	Period	Element id AuditEvent.period Short description When the activity occurred Definition The period during which the activity occurred. Comments The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] workflow: Event.occurred[x] w5: FiveWs.done[x] rim: ./effectiveTime[type=IVL_TS] dicom: EventDateTime w3c.prov: Activity.startTime & Activity.endTime fhirprovenance: Provenance.occurred[x]
recorded	Σ	1..1	instant	Element id AuditEvent.recorded Short description Time when the event was recorded Definition The time when the event was recorded. Requirements This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution. Comments In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.recorded rim: .effectiveTime w3c.prov: Activity.when fhirprovenance: Provenance.recorded
outcome	Σ	0..1	codeBinding	Element id AuditEvent.outcome Short description Whether the event succeeded or failed Definition Indicates whether the event succeeded or failed. Comments In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant. Data type code Binding Indicates whether the event succeeded or failed. AuditEventOutcome (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] rim: .actionNegationInd dicom: EventOutcomeIndicator
outcomeDesc	Σ	0..1	string	Element id AuditEvent.outcomeDesc Short description Description of the event outcome Definition A free text description of the outcome of the event. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=OUT].target.text dicom: EventOutcomeDescription
purposeOfEvent	Σ	0..*	CodeableConceptBinding	Element id AuditEvent.purposeOfEvent Short description The purposeOfUse of the event Definition The purposeOfUse (reason) that was used during the event being recorded. Comments Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD workflow: Event.reasonCode w5: FiveWs.why[x] rim: * .reasonCode [ControlActReason when Act.class = CACT Control Act] .outboundRelationship[typeCode=RSON].target dicom:* EventPurposeOfUse w3c.prov: Activity.Activity fhirprovenance: Provenance.reason, Provenance.activity
agent		1..*	BackboneElement	Element id AuditEvent.agent Short description Actor involved in the event Alternate names ActiveParticipant Definition An actor taking an active role in the event or activity that is logged. Requirements An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. Comments Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.performer w5: FiveWs.who rim: .participation dicom: ActiveParticipant w3c.prov: Agent fhirprovenance: Provenance.agent
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
type		0..1	CodeableConceptBinding	Element id AuditEvent.agent.type Short description How agent participated Definition Specification of the participation type the user plays when performing the event. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding The Participation type of the agent to the event. ParticipationRoleType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD workflow: Event.performer.function w5: FiveWs.who rim: .typeCode and/or .functionCode dicom: RoleIdCode w3c.prov: Agent.Attribution fhirprovenance: Provenance.agent.type
role		0..*	CodeableConcept	Element id AuditEvent.agent.role Short description Agent role in the event Definition The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. Requirements This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories. Comments Should be roles relevant to the event. Should not be an exhaustive list of roles. Data type CodeableConcept Binding What security role enabled the agent to participate in the event. SecurityRoleType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.who rim: .role dicom: RoleIdCode w3c.prov: Agent.Attribution fhirprovenance: Provenance.agent.role
who	Σ I	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Element id AuditEvent.agent.who Short description Identifier of who Alternate names userId Definition Reference to who this agent is that was involved in the event. Requirements This field ties an audit event to a specific resource or identifier. Comments Where a User ID is available it will go into who.identifier. Data type Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.performer.actor w5: FiveWs.who rim: .id dicom: UserId w3c.prov: Agent.Identity fhirprovenance: Provenance.agent.who
altId		0..1	string	Element id AuditEvent.agent.altId Short description Alternative User identity Definition Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. Requirements In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.who rim: .id (distinguish id type by root) dicom: AlternativeUserId w3c.prov: Agent.Identity
name		0..1	string	Element id AuditEvent.agent.name Short description Human friendly name for the agent Definition Human-meaningful name for the agent. Requirements The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.who rim: .name dicom: UserName w3c.prov: Agent.Identity
requestor	Σ	1..1	boolean	Element id AuditEvent.agent.requestor Short description Whether user is initiator Definition Indicator that the user is or is not the requestor, or initiator, for the event being audited. Requirements This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user. Comments There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.who rim: If participation.typeCode was author, then true dicom: UserIsRequestor
location	I	0..1	Reference(Location)	Element id AuditEvent.agent.location Short description Where Definition Where the event occurred. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.location w5: FiveWs.where[x] rim: * Role.Class =SDLOC Role.Code = ServiceDeliveryLocationRoleType Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant. w3c.prov:* Activity.location fhirprovenance: Provenance.location
policy		0..*	uri	Element id AuditEvent.agent.policy Short description Policy that authorized event Definition The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. Requirements This value is used retrospectively to determine the authorization policies. Comments For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.why[x] rim: ActPolicyType dicom: ParticipantRoleIDCode fhirprovenance: Provenance.policy
media		0..1	CodingBinding	Element id AuditEvent.agent.media Short description Type of media Definition Type of media involved. Used when the event is about exporting/importing onto media. Requirements Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD). Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Binding Used when the event is about exporting/importing onto media. MediaTypeCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.where[x] rim: .player.description.mediaType dicom: MediaType
network		0..1	BackboneElement	Element id AuditEvent.agent.network Short description Logical network location for application activity Definition Logical network location for application activity, if the activity has a network location. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.where[x] rim: .player.description.reference
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.network.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.network.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.network.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
address		0..1	string	Element id AuditEvent.agent.network.address Short description Identifier for the network access point of the user device Definition An identifier for the network access point of the user device for the audit event. Requirements This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers. Comments This could be a device id, IP address or some other identifier associated with a device. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.where[x] rim: pre-coordinated into URL dicom: NetworkAccessPointID w3c.prov: Agent.Location
type		0..1	codeBinding	Element id AuditEvent.agent.network.type Short description The type of network access point Definition An identifier for the type of network access point that originated the audit event. Requirements This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.where[x] rim: pre-coordinated into URL dicom: NetworkAccessPointTypeCode
purposeOfUse		0..*	CodeableConceptBinding	Element id AuditEvent.agent.purposeOfUse Short description Reason given for this user Definition The reason (purpose of use), specific to this agent, that was used during the event being recorded. Comments Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.why[x] rim: .reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) .outboundRelationship[typeCode=RSON or SUBJ].target w3c.prov: Agent.Activity
source		1..1	BackboneElement	Element id AuditEvent.source Short description Audit Event Reporter Definition The system that is reporting the event. Requirements The event is reported by one source. Comments Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.witness rim: .participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE] dicom: AuditSourceIdentification
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.source.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.source.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.source.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
site		0..1	string	Element id AuditEvent.source.site Short description Logical source location within the enterprise Definition Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. Requirements This value differentiates among the sites in a multi-site enterprise health information system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.witness rim: .scopedRole[classCode=LOCE].player.desc dicom: AuditEnterpriseSiteId
observer	Σ I	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Element id AuditEvent.source.observer Short description The identity of source detecting the event Alternate names SourceId Definition Identifier of the source where the event was detected. Requirements This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.witness rim: .id dicom: AuditSourceId
type		0..*	CodingBinding	Element id AuditEvent.source.type Short description The type of source where event originated Definition Code specifying the type of source where event originated. Requirements This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Binding Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.witness rim: .code dicom: AuditSourceTypeCode
entity	I	0..*	BackboneElement	Element id AuditEvent.entity Short description Data or objects used Alternate names ParticipantObject Definition Specific instances of data or objects that have been accessed. Requirements The event may have other entities involved. Comments Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` sev-1: Either a name or a query (NOT both) `name.empty() or query.empty()` Mappings rim: n/a w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role dicom: ParticipantObjectIdentification w3c.prov: Entity fhirprovenance: Provenance.target, Provenance.entity
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
what	Σ I	0..1	Reference(Resource)	Element id AuditEvent.entity.what Short description Specific instance of resource Definition Identifies a specific instance of the entity. The reference should be version specific. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.what[x] rim: .id dicom: ParticipantObjectID and ParticipantObjectIDTypeCode fhirprovenance: Provenance.target, Provenance.entity.what
type		0..1	CodingBinding	Element id AuditEvent.entity.type Short description Type of entity involved Definition The type of the object that was involved in this audit event. Requirements To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. Comments This value is distinct from the user's role or any user relationship to the entity. Data type Coding Binding Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.what[x] rim: [self::Act].code or role.player.code dicom: ParticipantObjectTypeCode w3c.prov: Entity.type fhirprovenance: Provenance.entity.type
role		0..1	CodingBinding	Element id AuditEvent.entity.role Short description What role the entity played Definition Code representing the role the entity played in the event being audited. Requirements For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Binding Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.context rim: role.code (not sure what this would mean for an Act) dicom: ParticipantObjectTypeCodeRole w3c.prov: Entity.role
lifecycle		0..1	CodingBinding	Element id AuditEvent.entity.lifecycle Short description Life-cycle stage for the entity Definition Identifier for the data life-cycle stage for the entity. Requirements Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. Comments This can be used to provide an audit trail for data, over time, as it passes through the system. Data type Coding Binding Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.context rim: target of ObservationEvent[code="lifecycle"].value dicom: ParticipantObjectDataLifeCycle w3c.prov: Entity.role fhirprovenance: Provenance.entity.role
securityLabel		0..*	CodingBinding	Element id AuditEvent.entity.securityLabel Short description Security labels on the entity Definition Security labels for the identified entity. Requirements This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. Comments Copied from entity meta security tags. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding w5: FiveWs.context rim: .confidentialityCode dicom: ParticipantObjectSensitivity
name	Σ I	0..1	string	Element id AuditEvent.entity.name Short description Descriptor for entity Definition A name of the entity in the audit event. Requirements Use only where entity can't be identified with an identifier. Comments This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: .title dicom: ParticipantObjectName w3c.prov: Entity.Label
description		0..1	string	Element id AuditEvent.entity.description Short description Descriptive text Definition Text that describes the entity in more detail. Requirements Use only where entity can't be identified with an identifier. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: .text dicom: ParticipantObjectDescription
query	Σ I	0..1	base64Binary	Element id AuditEvent.entity.query Short description Query parameters Definition The query parameters for a query-type entities. Requirements For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing. Comments The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: No mapping dicom: ParticipantObjectQuery
detail		0..*	BackboneElement	Element id AuditEvent.entity.detail Short description Additional Information about the entity Definition Tagged value pairs for conveying additional information about the entity. Requirements Implementation-defined data about specific details of the object accessed or used. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] dicom: ParticipantObjectDetail
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.detail.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.detail.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.detail.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
type		1..1	string	Element id AuditEvent.entity.detail.type Short description Name of the property Definition The type of extra detail provided in the value. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: .code dicom: ParticipantObjectDetail.type
value[x]		1..1		Element id AuditEvent.entity.detail.value[x] Short description Property value Definition The value of the extra detail. Requirements Should not duplicate the entity value unless absolutely necessary. Comments The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.context rim: .value dicom: ParticipantObjectDetail.value
valueString			string	Data type string
valueBase64Binary			base64Binary	Data type base64Binary

action

SHALL be present. Code from base HL7 resource, only C (create), R (read) and U (update) would usually be expected.

"action": "U",

agent

SHOULD be present for any user initiated actions. Reference to the user or system that triggered the creation/read/update. Identity SHOULD be determined through the appropriate authentication token within the request header, e.g. CIS2 auth token.

"agent":  [
        {
            "type": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                        "code": "AUT",
                        "display": "author (originator)"
                    }
                ]
            },
            "who": {
                "reference": "PractitionerRole/PractitionerRole-TestClinicalScientist-Example",
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/sds-user-id",
                    "value": "9999999997"
                }
            },
            "name": "Test Clinical Scientist",
            "requestor": true
        }
    ],

entity

SHOULD be present where the resource exists on the server. Reference to the resource which was affected by the event.

"entity":  [
        {
            "what": {
                "reference": "Task/Task-NonWGSRareDiseaseTestOrderRejected-Example"
            },
            "type": {
                "system": "http://hl7.org/fhir/resource-types",
                "code": "Task",
                "display": "Task"
            },
            "role": {
                "system": "http://terminology.hl7.org/CodeSystem/object-role",
                "code": "20",
                "display": "Job"
            }
        }
    ]