Mobile access to Health Documents (MHD)
5.0.0-current - ci-build
Mobile access to Health Documents (MHD)
5.0.0-current - ci-build
Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 5.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.BasicAudit.MHD5.PatientRead | Version: 5.0.0-current | |||
| Active as of 2025-10-13 | Computable Name: PatientRead | |||
A basic AuditEvent profile for when a RESTful Read action happens successfully, and where there is an identifiable Patient subject associated with the read Resource.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  AuditEvent |
0..* | Read | Record of an event | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 Slices for category |
Σ | 1..* | CodeableConcept | Type/identifier of event Slice: Unordered, Open by value:$this Binding: AuditEventID (example): Type of event. |
   category:anyRead |
Σ | 1..1 | CodeableConcept | Type/identifier of event Binding: all Reads (required) |
 code |
Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action Required Pattern: R |
| recorded |
Σ | 1..1 | instant | Time when the event was recorded |
| Slices for agent |
Σ | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type |
  agent:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| agent:client |
Σ | 1..1 | BackboneElement | Actor involved in the event |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
  network[x] |
1..1 | This agent network location for the activity | ||
 networkReference |
Reference(Endpoint) | |||
| networkUri |
uri | |||
| networkString |
string | |||
| agent:server |
Σ | 1..1 | BackboneElement | Actor involved in the event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| network[x] |
1..1 | This agent network location for the activity | ||
| networkReference |
Reference(Endpoint) | |||
| networkUri |
uri | |||
| networkString |
string | |||
| agent:user |
Σ | 0..1 | BackboneElement | Actor involved in the event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor |
Σ | 0..1 | boolean | Whether user is initiator Required Pattern: true |
| policy |
S | 0..* | uri | Policy that authorized the agent participation in the event |
| source |
SΣ | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| Slices for entity |
Σ | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:role |
| entity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction |
Σ | 0..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| entity:data |
Σ | 1..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Resource) | Specific instance of resource |
| entity:patient |
Σ | 1..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Patient) | Specific instance of resource |
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.category | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.category:anyRead | Base | required | all Reads | 📦5.0.0-current | This IG |
| AuditEvent.code | Base | example | Audit Event Sub-Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.action | Base | required | Audit Event Action | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AuditEvent | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AuditEvent | 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-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Read
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | Record of an event | |
| entity |
2..* | BackboneElement | Data or objects used | |
| Slices for entity |
Content/Rules for all slices | |||
| entity:patient |
1..1 | BackboneElement | Data or objects used | |
| what |
1..1 | Reference(Patient) | Specific instance of resource | |
| role |
1..1 | CodeableConcept | What role the entity played Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | Read | Record of an event | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for category |
Σ | 1..* | CodeableConcept | Type/identifier of event Slice: Unordered, Open by value:$this Binding: AuditEventID (example): Type of event. | ||||
| category:anyRead |
Σ | 1..1 | CodeableConcept | Type/identifier of event Binding: all Reads (required) | ||||
| code |
Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action Required Pattern: R | ||||
| severity |
Σ | 0..1 | code | emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | ||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome |
Σ | 0..1 | BackboneElement | Whether the event succeeded or failed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-outcome | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| detail |
Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. | ||||
| authorization |
Σ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient |
0..1 | Reference(Patient) | The patient is the subject of the data used/created/updated/deleted during the activity | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| Slices for agent |
Σ | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type | ||||
| agent:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
0..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:client |
Σ | 1..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
1..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:server |
Σ | 1..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
1..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:user |
Σ | 0..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator Required Pattern: true | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
S | 0..* | uri | Policy that authorized the agent participation in the event | ||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| source |
SΣ | 1..1 | BackboneElement | Audit Event Reporter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site |
0..1 | Reference(Location) | Logical source location within the enterprise | |||||
| observer |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event | ||||
| type |
0..* | CodeableConcept | The type of source where event originated Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema. | |||||
| Slices for entity |
Σ | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:role | ||||
| entity:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| role |
0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:transaction |
Σ | 0..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
ΣC | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:data |
Σ | 1..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
| role |
0..1 | CodeableConcept | What role the entity played Binding: RESTful objects role in the event (required) | |||||
| securityLabel |
0..* | CodeableConcept | may contain the security labels on the resource returned Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:patient |
Σ | 1..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 1..1 | Reference(Patient) | Specific instance of resource | ||||
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| AuditEvent.category | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.category:anyRead | Base | required | all Reads | 📦5.0.0-current | This IG |
| AuditEvent.code | Base | example | Audit Event Sub-Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.action | Base | required | Audit Event Action | 📍5.0.0 | FHIR Std. |
| AuditEvent.severity | Base | required | Audit Event Severity | 📍5.0.0 | FHIR Std. |
| AuditEvent.outcome.code | Base | preferred | Audit Event Outcome | 📍5.0.0 | FHIR Std. |
| AuditEvent.outcome.detail | Base | example | Audit Event Outcome Detail | 📍5.0.0 | FHIR Std. |
| AuditEvent.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:client.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:server.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:user.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.source.type | Base | preferred | Audit Event Source Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:data.role | Base | required | RESTful objects role in the event | 📦5.0.0-current | This IG |
| AuditEvent.entity:data.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:data.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AuditEvent | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AuditEvent | 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-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Read
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | Record of an event | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for category |
Σ | 1..* | CodeableConcept | Type/identifier of event Slice: Unordered, Open by value:$this Binding: AuditEventID (example): Type of event. |
| category:anyRead |
Σ | 1..1 | CodeableConcept | Type/identifier of event Binding: all Reads (required) |
| code |
Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action Required Pattern: R |
| recorded |
Σ | 1..1 | instant | Time when the event was recorded |
| Slices for agent |
Σ | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type |
| agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| agent:client |
Σ | 1..1 | BackboneElement | Actor involved in the event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| network[x] |
1..1 | This agent network location for the activity | ||
| networkReference |
Reference(Endpoint) | |||
| networkUri |
uri | |||
| networkString |
string | |||
| agent:server |
Σ | 1..1 | BackboneElement | Actor involved in the event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| network[x] |
1..1 | This agent network location for the activity | ||
| networkReference |
Reference(Endpoint) | |||
| networkUri |
uri | |||
| networkString |
string | |||
| agent:user |
Σ | 0..1 | BackboneElement | Actor involved in the event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. |
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor |
Σ | 0..1 | boolean | Whether user is initiator Required Pattern: true |
| policy |
S | 0..* | uri | Policy that authorized the agent participation in the event |
| source |
SΣ | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| Slices for entity |
Σ | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:role |
| entity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:transaction |
Σ | 0..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| entity:data |
Σ | 1..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Resource) | Specific instance of resource |
| entity:patient |
Σ | 1..1 | BackboneElement | Data or objects used |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what |
Σ | 1..1 | Reference(Patient) | Specific instance of resource |
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.category | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.category:anyRead | Base | required | all Reads | 📦5.0.0-current | This IG |
| AuditEvent.code | Base | example | Audit Event Sub-Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.action | Base | required | Audit Event Action | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AuditEvent | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AuditEvent | 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-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Read
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AuditEvent |
0..* | Read | Record of an event | |
| entity |
2..* | BackboneElement | Data or objects used | |
| Slices for entity |
Content/Rules for all slices | |||
| entity:patient |
1..1 | BackboneElement | Data or objects used | |
| what |
1..1 | Reference(Patient) | Specific instance of resource | |
| role |
1..1 | CodeableConcept | What role the entity played Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent |
0..* | Read | Record of an event | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for category |
Σ | 1..* | CodeableConcept | Type/identifier of event Slice: Unordered, Open by value:$this Binding: AuditEventID (example): Type of event. | ||||
| category:anyRead |
Σ | 1..1 | CodeableConcept | Type/identifier of event Binding: all Reads (required) | ||||
| code |
Σ | 1..1 | CodeableConcept | Specific type of event Binding: AuditEventSubType (example): Specific type of event. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: rest | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action Required Pattern: R | ||||
| severity |
Σ | 0..1 | code | emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | ||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome |
Σ | 0..1 | BackboneElement | Whether the event succeeded or failed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-outcome | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| detail |
Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. | ||||
| authorization |
Σ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient |
0..1 | Reference(Patient) | The patient is the subject of the data used/created/updated/deleted during the activity | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| Slices for agent |
Σ | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type | ||||
| agent:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
0..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:client |
Σ | 1..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
1..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:server |
Σ | 1..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] |
1..1 | This agent network location for the activity | ||||||
| networkReference |
Reference(Endpoint) | |||||||
| networkUri |
uri | |||||||
| networkString |
string | |||||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| agent:user |
Σ | 0..1 | BackboneElement | Actor involved in the event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| role |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor |
Σ | 0..1 | boolean | Whether user is initiator Required Pattern: true | ||||
| location |
0..1 | Reference(Location) | The agent location when the event occurred | |||||
| policy |
S | 0..* | uri | Policy that authorized the agent participation in the event | ||||
| authorization |
0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | |||||
| source |
SΣ | 1..1 | BackboneElement | Audit Event Reporter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site |
0..1 | Reference(Location) | Logical source location within the enterprise | |||||
| observer |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event | ||||
| type |
0..* | CodeableConcept | The type of source where event originated Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema. | |||||
| Slices for entity |
Σ | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:role | ||||
| entity:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| role |
0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:transaction |
Σ | 0..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
ΣC | 1..1 | string | the value of X-Request-Id Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XrequestId | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:data |
Σ | 1..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 1..1 | Reference(Resource) | Specific instance of resource | ||||
| role |
0..1 | CodeableConcept | What role the entity played Binding: RESTful objects role in the event (required) | |||||
| securityLabel |
0..* | CodeableConcept | may contain the security labels on the resource returned Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| entity:patient |
Σ | 1..1 | BackboneElement | Data or objects used | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what |
Σ | 1..1 | Reference(Patient) | Specific instance of resource | ||||
| role |
1..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| securityLabel |
0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query |
Σ | 0..1 | base64Binary | Query parameters | ||||
| detail |
0..* | BackboneElement | Additional Information about the entity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] |
1..1 | Property value | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueBase64Binary |
base64Binary | |||||||
| agent |
0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| AuditEvent.category | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.category:anyRead | Base | required | all Reads | 📦5.0.0-current | This IG |
| AuditEvent.code | Base | example | Audit Event Sub-Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.action | Base | required | Audit Event Action | 📍5.0.0 | FHIR Std. |
| AuditEvent.severity | Base | required | Audit Event Severity | 📍5.0.0 | FHIR Std. |
| AuditEvent.outcome.code | Base | preferred | Audit Event Outcome | 📍5.0.0 | FHIR Std. |
| AuditEvent.outcome.detail | Base | example | Audit Event Outcome Detail | 📍5.0.0 | FHIR Std. |
| AuditEvent.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:client.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:client.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:server.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:server.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.agent:user.type | Base | preferred | Participation Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.role | Base | example | Security Role Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.agent:user.authorization | Base | example | PurposeOfUse | 📦3.1.0 | THO v6.5 |
| AuditEvent.source.type | Base | preferred | Audit Event Source Type | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.what.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:transaction.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:data.role | Base | required | RESTful objects role in the event | 📦5.0.0-current | This IG |
| AuditEvent.entity:data.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:data.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.role | Base | example | Audit Event Entity Role | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| AuditEvent.entity:patient.detail.type | Base | example | Audit Event ID | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AuditEvent | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AuditEvent | 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-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AuditEvent | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Read
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ IHE IT Infrastructure Technical Committee. Package ihe.iti.mhd#5.0.0-current based on FHIR 5.0.0. Generated 2025-10-13
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change