Danish Advanced Directives for Do Not Resuscitate (DNR) - Implementation Guide
0.2.0 - ci-build

Danish Advanced Directives for Do Not Resuscitate (DNR) - Implementation Guide, published by Trifork. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/trifork/fgvhr-ig/ and changes regularly. See the Directory of published versions

Resource Profile: FGVHAuditEvent

Official URL: http://example.org/StructureDefinition/fgvh-audit-event Version: 0.2.0
Draft as of 2024-11-21 Computable Name: FGVHAuditEvent

Registration of an Audit Event

AuditEvents can be used to registered to MinLog2 with the following query:

POST [base]/fhir/AuditEvent

Along with the query, a body is sent which can be interpreted as follow:

Property Value Explanation
resourceType "AuditEvent" A string specifying this is an AuditEvent. Can't be changed
recorded "YYYY-mm-DDTHH:MM:ssK" Datetime format with time zone in
agent [ ] Array with all actors and systems involved in the event
agent.type   Participant role code, specifying the role the actor had. Normally AGNT or PROV
agent.name "Human readable name" This field is used to display the actor's title
agent.requestor false/true If this was the initial requestor. This might be the one taking the emergency call in the first place
agent.who { } Information object about the actor
agent.who.display "Human readable description" This field is used to display who acted (name of individual or system)
agent.who.identifier "Emergency dispatcher" Information object about the actor
agent.who.identifier.system urn:oid:1.2.208.176.1.1 or urn:oid:1.2.208.176.1.2 Public available identifier of the actor. For people, use CPR, and for systems use SOR.
agent.who.identifier.value 010101-0101 The CPR number or the SOR code
source { } The calling system that makes this very request
source.type   The audit source type
source.observer.identifier.system urn:oid:1.2.208.176.1.1 SOR code of the system calling
source.observer.identifier.value 615961000016003 SOR code for calling system. Can be found in the Sor Browser
entity [ ] Object of what was looked up and on who
entity.name A patient's consents Name of what is looked up
entity.description Patient consents from the search query A description of what was searched for
entity.what { } Object about what was searched for
entity.what.identifier.system urn:oid:1.2.208.176.1.1 or urn:oid:1.2.208.176.1.2 Public available identifier of the actor. For people, use CPR, and for systems use SOR
entity.what.identifier.value 010101-0101 The CPR number or the SOR code

With the following format, a chain of agents can be listed, such as the dispatcher taking the call, the system making the look-up, the ambulances getting the data, and paramedics on site. You can also include an agent with a trace.

The audit event is sent with a body as well, containing the AuditEvents for MinLog2:

Body:

{
  "resourceType": "AuditEvent",
  "recorded": "2024-05-22T09:17:52.709+00:00",
  "agent": [
    {
      "role": [
        {
          "coding": [
            {
              "code": "AGNT",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "system": "urn:oid:1.2.208.176.1.2",
          "value": "0202820103"
        },
        "type": "PractitionerRole",
        "display": "Terry Telefonmand"
      },
      "name": "Dispatcher",
      "requestor": true
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "PROV",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "system": "urn:oid:1.2.208.176.1.1",
          "value": "615961000016003"
        },
        "type": "System",
        "display": "SOR-kode for Logis Region Midt"
      },
      "type": {
        "coding": [
          {
            "code": "2",
            "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
            "display": "Data Interface"
          }
        ]
      },
      "name": "AMK Vagtcentral",
      "requestor": false
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "PROV",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "system": "urn:logis:audit:otel/trace",
          "value": "6860b86b78dc73af887ceb3146bc676c"
        },
        "display": "Skærm, som viser information til ambulancefolk"
      },
      "type": {
        "coding": [
          {
            "code": "1",
            "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
            "display": "User Device"
          }
        ]
      },
      "name": "Ambulance",
      "requestor": false
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "LIC",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "system": "urn:oid:1.2.208.176.1.2",
          "value": "0108589995"
        },
        "type": "Practitioner",
        "display": "Personale 1, som rykkede ud"
      },
      "name": "Ambulance personale",
      "requestor": false
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "LIC",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "system": "BSK-system",
          "value": "BSK/123"
        },
        "type": "Practitioner",
        "display": "Personale 2, som rykkede ud. Vedkommende er ikke kendt med CPR-nummer ved indmelding."
      },
      "name": "Ambulance personale",
      "requestor": false
    }
  ],
  "source": {
    "observer": {
      "identifier": {
        "system": "urn:logis:audit/source",
        "value": "Logis Region Midt"
      }
    },
    "type": [
      {
        "code": "4",
        "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
        "display": "Application Server"
      }
    ]
  },
  "entity": [
    {
      "what": {
        "identifier": {
          "system": "urn:oid:1.2.208.176.1.2",
          "value": "0108589995"
        },
        "type": "Consent"
      },
      "role": {
        "code": "4",
        "system": "http://terminology.hl7.org/CodeSystem/object-role"
      },
      "name": "A Patient's Consents",
      "description": "Patient Consents from the search query"
    }
  ]
}

Response:

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PatientCreate

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* PatientCreate Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.


Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.



Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


Required Pattern: 0
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... requestor Σ 1..1 boolean Whether user is initiator
.... 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 (extensible): The Participation type of the agent to the event.


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://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... requestor Σ 1..1 boolean Whether user is initiator
..... network 1..1 BackboneElement Logical network location for application activity
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 (extensible): The Participation type of the agent to the event.


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://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... requestor Σ 1..1 boolean Whether user is initiator
..... network 1..1 BackboneElement Logical network location for application activity
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source S 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
... Slices for entity C 2..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
sev-1: Either a name or a query (NOT both)
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:transaction C 0..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:data C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
.... entity:patient C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


Required Pattern: At least the following
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.typeextensiblePattern: rest
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:anyCreateextensiblePattern: create
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.outcomerequiredPattern: 0
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.agent:client.typeextensiblePattern: 110153
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:server.typeextensiblePattern: 110152
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:user.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.entity:transaction.typeextensiblePattern: XrequestId
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.typeextensiblePattern: 2
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.rolerequiredRestObjectRoles
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
AuditEvent.entity:patient.typeextensiblePattern: 1
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:patient.roleextensiblePattern: 1
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:data, AuditEvent.entity:patientEither a name or a query (NOT both)
: name.empty() or query.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* PatientCreate Event record kept for security purposes
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): 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
.... 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
... Slices for subtype Σ 1..* Coding More specific type/id for the event
Slice: Unordered, Open by value:$this
Binding: AuditEventSub-Type (extensible): Sub-type of event.


.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-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
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.


Required Pattern: C
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


Required Pattern: 0
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern: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 (extensible): 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 (extensible): 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 (extensible): 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 0..1 CodeableConcept How agent participated
Binding: participant source types for RESTful create (required)
..... 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C 2..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
sev-1: Either a name or a query (NOT both)
.... 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
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction C 0..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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 string 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")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string 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: Identifier Type Codes (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 Σ 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 Σ 0..1 string Text alternative for the resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/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
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:data C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding may contain the security labels on the resource returned
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... 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
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit 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
...... 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
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensiblePattern: rest
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:anyCreateextensiblePattern: create
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredPattern: C
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredPattern: 0
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:client.typeextensiblePattern: 110153
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:client.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:client.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:server.typeextensiblePattern: 110152
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:server.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:server.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:server.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:user.typerequiredDataSources
https://profiles.ihe.net/ITI/BALP/ValueSet/DataSources
AuditEvent.agent:user.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:user.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:transaction.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.entity:transaction.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:transaction.what.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.entity:transaction.typeextensiblePattern: XrequestId
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:transaction.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:transaction.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:transaction.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:data.typeextensiblePattern: 2
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.rolerequiredRestObjectRoles
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
AuditEvent.entity:data.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:data.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:patient.typeextensiblePattern: 1
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:patient.roleextensiblePattern: 1
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:patient.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:patient.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:data, AuditEvent.entity:patientEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from PatientCreate

Summary

Differential View

This structure is derived from PatientCreate

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* PatientCreate Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.


Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.



Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


Required Pattern: 0
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... requestor Σ 1..1 boolean Whether user is initiator
.... 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 (extensible): The Participation type of the agent to the event.


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://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... requestor Σ 1..1 boolean Whether user is initiator
..... network 1..1 BackboneElement Logical network location for application activity
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 (extensible): The Participation type of the agent to the event.


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://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... requestor Σ 1..1 boolean Whether user is initiator
..... network 1..1 BackboneElement Logical network location for application activity
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source S 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
... Slices for entity C 2..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
sev-1: Either a name or a query (NOT both)
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:transaction C 0..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:data C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Resource) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
.... entity:patient C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


Required Pattern: At least the following
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.typeextensiblePattern: rest
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:anyCreateextensiblePattern: create
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.outcomerequiredPattern: 0
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.agent:client.typeextensiblePattern: 110153
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:server.typeextensiblePattern: 110152
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:user.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.entity:transaction.typeextensiblePattern: XrequestId
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.typeextensiblePattern: 2
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.rolerequiredRestObjectRoles
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
AuditEvent.entity:patient.typeextensiblePattern: 1
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:patient.roleextensiblePattern: 1
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:data, AuditEvent.entity:patientEither a name or a query (NOT both)
: name.empty() or query.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* PatientCreate Event record kept for security purposes
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): 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
.... 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
... Slices for subtype Σ 1..* Coding More specific type/id for the event
Slice: Unordered, Open by value:$this
Binding: AuditEventSub-Type (extensible): Sub-type of event.


.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-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
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.


Required Pattern: C
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


Required Pattern: 0
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern: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 (extensible): 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

..... network 0..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 (extensible): 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 (extensible): 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... 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
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 0..1 CodeableConcept How agent participated
Binding: participant source types for RESTful create (required)
..... 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(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): 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 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C 2..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
sev-1: Either a name or a query (NOT both)
.... 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
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction C 0..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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 string 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")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string 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: Identifier Type Codes (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 Σ 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 Σ 0..1 string Text alternative for the resource
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/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
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:data C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding may contain the security labels on the resource returned
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 1..1 BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
..... 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
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit 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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... 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
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit 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
...... 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
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 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 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensiblePattern: rest
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:anyCreateextensiblePattern: create
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredPattern: C
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredPattern: 0
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:client.typeextensiblePattern: 110153
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:client.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:client.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:server.typeextensiblePattern: 110152
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:server.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:server.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:server.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:user.typerequiredDataSources
https://profiles.ihe.net/ITI/BALP/ValueSet/DataSources
AuditEvent.agent:user.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:user.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:transaction.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.entity:transaction.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:transaction.what.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.entity:transaction.typeextensiblePattern: XrequestId
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:transaction.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:transaction.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:transaction.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:data.typeextensiblePattern: 2
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.rolerequiredRestObjectRoles
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
AuditEvent.entity:data.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:data.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:patient.typeextensiblePattern: 1
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:patient.roleextensiblePattern: 1
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:patient.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity:patient.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:data, AuditEvent.entity:patientEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from PatientCreate

Summary

 

Other representations of profile: CSV, Excel, Schematron