Basic Audit Log Patterns (BALP)
1.1.3 - Trial-Implementation International flag

This page is part of the IHE Basic Audit Log Patterns (BALP) (v1.1.3: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Basic AuditEvent pattern for when an activity was authorized by an SAML access token Comprehensive

Official URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.SAMLaccessTokenUse.Comprehensive Version: 1.1.3
Active as of 2024-02-14 Computable Name: SAMLaccessTokenUseComprehensive

A basic AuditEvent profile for when an activity was authorized by an SAML access token. This profile is expected to be used with some other detail that explains the activity. This profile only covers the SAML access token.

The following table uses a short-hand for the SAML fields and FHIR AuditEvent elements to keep the table compact. It is presumed the reader can understand the SAML field and the FHIR AuditEvent element given. Note the ~ character represents attributes under the SAML AttributeStatement.

Builds upon the Minimal

SAML field Comprehensive AuditEvent
ID agent[user].policy
Issuer agent[user].who.identifier.system
Subject.NameID agent[user].who.identifier.value
~subject:role agent[user].role
~subject:purposeofuse agent[user].purposeOfUse
AuthnContextClassRef agent[user].extension[assuranceLevel]
~subject:subject-id agent[user].extension[otherId][subject-id].value
~subject:npi agent[user].extension[otherId][npi].value
~subject:provider-identifier agent[user].extension[otherId][provider-id].value
~subject:organization agent[userorg].who.display
~subject:organization-id agent[userorg].who.identifier.value
~homeCommunityId agent[homeCommunityId].who.identifier.value
~bppc:2007:docid entity[consent].what.identifier.value
~xua:2012:acp entity[consent].detail.valueString
~resource:resource-id entity[consent-patient].what.identifier.value

Usage:

Formal Views of Profile Content

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

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
.... agent:user 1..*BackboneElementActor involved in the event
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... extension:otherId/subject-id 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
........ value S1..1stringSAML Attribute subject-id
...... extension:otherId/npi 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
........ value S1..1stringSAML Attribute npi
...... extension:otherId/provider-id 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
........ value S1..1stringSAML Attribute provider-identifier
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
..... role S0..*CodeableConceptSAML subject:role(s)
..... who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier
....... system S0..1uriSAML Issuer
....... value S1..1stringSAML Subject.NameID
..... altId 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: true
..... policy S1..1uriSAML token ID
..... media 0..0
..... network 0..0
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
.... agent:userorg 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
..... role 0..0
..... who
...... identifier
....... value S1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
...... display S1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... altId 0..0
..... name 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: false
..... location 0..0
..... policy 0..0
..... media 0..0
..... network 0..0
..... purposeOfUse 0..0
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
..... role 0..0
..... who
...... identifier S1..1IdentifierhomeCommunityId
..... altId 0..0
..... name 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: false
..... location 0..0
..... policy 0..0
..... media 0..0
..... network 0..0
..... purposeOfUse 0..0
... Slices for entity 0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:consent 0..*BackboneElementData or objects used
..... what
...... identifier S0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
..... type 1..1CodingType of entity involved
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... recorded Σ1..1instantTime when the event was recorded
... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... requestor Σ1..1booleanWhether user is initiator
.... agent:user 1..*BackboneElementActor involved in the event
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... otherId/subject-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
........ value SΣ1..1stringSAML Attribute subject-id
Example General: 123456
...... otherId/npi S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
........ value SΣ1..1stringSAML Attribute npi
Example General: 123456
...... otherId/provider-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
........ value SΣ1..1stringSAML Attribute provider-identifier
Example General: 123456
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
..... role S0..*CodeableConceptSAML subject:role(s)
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... system SΣ0..1uriSAML Issuer
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Subject.NameID
Example General: 123456
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: true
..... policy S1..1uriSAML token ID
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:userorg 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... value SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
Example General: 123456
...... display SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier SΣ1..1IdentifierhomeCommunityId
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
... source 1..1BackboneElementAudit Event Reporter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity:consent C0..*BackboneElementData or objects used
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... identifier SΣ0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].typeextensiblePattern: SAML-subject-id
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].typeextensiblePattern: NPI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].typeextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.typeextensiblePattern: UserSamlAgent
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.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:userorg.typeextensiblePattern: PROV
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:userorg.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:homeCommunityId.typeextensiblePattern: homeCommunityId
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.entity:consent.typeextensiblePattern: Consent
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... subtype Σ0..*CodingMore specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


... action Σ0..1codeType of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1PeriodWhen the activity occurred
... recorded Σ1..1instantTime when the event was recorded
... outcome Σ0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ0..1stringDescription of the event outcome
... purposeOfEvent Σ0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.

..... role 0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... altId 0..1stringAlternative User identity
..... name 0..1stringHuman friendly name for the agent
..... requestor Σ1..1booleanWhether user is initiator
..... location 0..1Reference(Location)Where
..... policy 0..*uriPolicy that authorized event
..... media 0..1CodingType of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

..... network 0..1BackboneElementLogical network location for application activity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... address 0..1stringIdentifier for the network access point of the user device
...... type 0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:user 1..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... otherId/subject-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute subject-id
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... otherId/npi S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute npi
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... otherId/provider-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute provider-identifier
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role S0..*CodeableConceptSAML subject:role(s)
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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 SΣ0..1uriSAML Issuer
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Subject.NameID
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... name 0..1stringHuman friendly name for the agent
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: true
..... location 0..1Reference(Location)Where
..... policy S1..1uriSAML token ID
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:userorg 0..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ1..1IdentifierhomeCommunityId
...... display Σ0..1stringText alternative for the resource
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
... source 1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1stringLogical source location within the enterprise
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type 0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
..... type 0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

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

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

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


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:consent C0..*BackboneElementData or objects used
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... role 0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

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

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


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:All Slices Content/Rules for all slices
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

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.typeextensibleAuditEventID
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.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
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:user.extension:otherId/subject-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].typeextensiblePattern: SAML-subject-id
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].typeextensiblePattern: NPI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].typeextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.typeextensiblePattern: UserSamlAgent
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.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:user.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.who.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-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.agent:userorg.typeextensiblePattern: PROV
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:userorg.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:userorg.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:userorg.who.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:userorg.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:homeCommunityId.typeextensiblePattern: homeCommunityId
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:homeCommunityId.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:homeCommunityId.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
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
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:consent.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:consent.typeextensiblePattern: Consent
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:consent.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:consent.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:consent.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

This structure is derived from AuditEvent

Summary

Mandatory: 4 elements (10 nested mandatory elements)
Must-Support: 20 elements
Prohibited: 19 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element AuditEvent.agent is sliced based on the value of pattern:type
  • The element AuditEvent.entity is sliced based on the value of pattern:type
  • The element AuditEvent.entity.detail is sliced based on the value of pattern:type

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
.... agent:user 1..*BackboneElementActor involved in the event
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... extension:otherId/subject-id 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
........ value S1..1stringSAML Attribute subject-id
...... extension:otherId/npi 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
........ value S1..1stringSAML Attribute npi
...... extension:otherId/provider-id 0..*OtherIdAuditEvent.agent other identifiers
....... value[x]
........ type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
........ value S1..1stringSAML Attribute provider-identifier
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
..... role S0..*CodeableConceptSAML subject:role(s)
..... who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier
....... system S0..1uriSAML Issuer
....... value S1..1stringSAML Subject.NameID
..... altId 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: true
..... policy S1..1uriSAML token ID
..... media 0..0
..... network 0..0
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
.... agent:userorg 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
..... role 0..0
..... who
...... identifier
....... value S1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
...... display S1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... altId 0..0
..... name 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: false
..... location 0..0
..... policy 0..0
..... media 0..0
..... network 0..0
..... purposeOfUse 0..0
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
..... role 0..0
..... who
...... identifier S1..1IdentifierhomeCommunityId
..... altId 0..0
..... name 0..0
..... requestor 1..1booleanWhether user is initiator
Required Pattern: false
..... location 0..0
..... policy 0..0
..... media 0..0
..... network 0..0
..... purposeOfUse 0..0
... Slices for entity 0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:consent 0..*BackboneElementData or objects used
..... what
...... identifier S0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
..... type 1..1CodingType of entity involved
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... recorded Σ1..1instantTime when the event was recorded
... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... requestor Σ1..1booleanWhether user is initiator
.... agent:user 1..*BackboneElementActor involved in the event
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... otherId/subject-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
........ value SΣ1..1stringSAML Attribute subject-id
Example General: 123456
...... otherId/npi S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
........ value SΣ1..1stringSAML Attribute npi
Example General: 123456
...... otherId/provider-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
........ value SΣ1..1stringSAML Attribute provider-identifier
Example General: 123456
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
..... role S0..*CodeableConceptSAML subject:role(s)
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... system SΣ0..1uriSAML Issuer
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Subject.NameID
Example General: 123456
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: true
..... policy S1..1uriSAML token ID
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:userorg 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... value SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
Example General: 123456
...... display SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... identifier SΣ1..1IdentifierhomeCommunityId
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
... source 1..1BackboneElementAudit Event Reporter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity:consent C0..*BackboneElementData or objects used
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... identifier SΣ0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].typeextensiblePattern: SAML-subject-id
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].typeextensiblePattern: NPI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].typeextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.typeextensiblePattern: UserSamlAgent
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.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:userorg.typeextensiblePattern: PROV
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:userorg.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:homeCommunityId.typeextensiblePattern: homeCommunityId
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.entity:consent.typeextensiblePattern: Consent
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... subtype Σ0..*CodingMore specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


... action Σ0..1codeType of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1PeriodWhen the activity occurred
... recorded Σ1..1instantTime when the event was recorded
... outcome Σ0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ0..1stringDescription of the event outcome
... purposeOfEvent Σ0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.

..... role 0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... altId 0..1stringAlternative User identity
..... name 0..1stringHuman friendly name for the agent
..... requestor Σ1..1booleanWhether user is initiator
..... location 0..1Reference(Location)Where
..... policy 0..*uriPolicy that authorized event
..... media 0..1CodingType of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

..... network 0..1BackboneElementLogical network location for application activity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... address 0..1stringIdentifier for the network access point of the user device
...... type 0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

..... purposeOfUse 0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:user 1..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url, value:value.ofType(Identifier).type
...... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
...... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
...... otherId/subject-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/OtherIdentifierTypes
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: SAML-subject-id
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute subject-id
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... otherId/npi S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute npi
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... otherId/provider-id S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId"
....... value[x] 1..1IdentifierValue of extension
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription 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.


Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
.......... id0..1stringUnique id for inter-element referencing
.......... extension0..*ExtensionAdditional content defined by implementations
.......... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
.......... version0..1stringVersion of the system - if relevant
.......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
.......... display0..1stringRepresentation defined by the system
.......... userSelected0..1booleanIf this coding was chosen directly by the user
......... text0..1stringPlain text representation of the concept
........ system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value SΣ1..1stringSAML Attribute provider-identifier
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: UserSamlAgent
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role S0..*CodeableConceptSAML subject:role(s)
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


..... who Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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 SΣ0..1uriSAML Issuer
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Subject.NameID
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... name 0..1stringHuman friendly name for the agent
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: true
..... location 0..1Reference(Location)Where
..... policy S1..1uriSAML token ID
..... purposeOfUse S0..*CodeableConceptSAML subject:purposeofuse
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... agent:userorg 0..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization-id
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display SΣ1..1stringSAML Attribute urn:oasis:names:tc:xspa:1.0:subject:organization
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
.... agent:homeCommunityId 0..*BackboneElementActor involved in the event
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... assuranceLevel S0..*CodeableConceptAuditEvent.agent Assurance Level
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-assuranceLevel
Binding: SecurityTrustAssuranceObservationValue (preferred)
..... otherId S0..*IdentifierAuditEvent.agent other identifiers
URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/ihe-otherId
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: urn:ihe:iti:xca:2010
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: homeCommunityId
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ1..1IdentifierhomeCommunityId
...... display Σ0..1stringText alternative for the resource
..... requestor Σ1..1booleanWhether user is initiator
Required Pattern: false
... source 1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1stringLogical source location within the enterprise
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type 0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
..... type 0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

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

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

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


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:consent C0..*BackboneElementData or objects used
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier SΣ0..1IdentifierBPPC Patient Privacy Policy Acknowledgement Document unique id
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Consent
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... role 0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

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

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


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
...... detail:All Slices Content/Rules for all slices
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:acp 0..1BackboneElementHome Community ID where the Consent is.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:ihe:iti:xua:2012:acp
....... value[x] 1..1stringProperty value
...... detail:patient-id 0..1BackboneElementThe Patient Identity where the Consent is.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Required Pattern: urn:oasis:names:tc:xacml:2.0:resource:resource-id
....... value[x] 1..1stringProperty value

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.typeextensibleAuditEventID
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.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
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:user.extension:otherId/subject-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/subject-id.value[x].typeextensiblePattern: SAML-subject-id
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/npi.value[x].typeextensiblePattern: NPI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.extension:otherId/provider-id.value[x].typeextensiblePattern: PRN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:user.typeextensiblePattern: UserSamlAgent
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.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:user.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:user.who.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-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.agent:userorg.typeextensiblePattern: PROV
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:userorg.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:userorg.who.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.agent:userorg.who.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.agent:userorg.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:homeCommunityId.typeextensiblePattern: homeCommunityId
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:homeCommunityId.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent:homeCommunityId.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
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
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:consent.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:consent.typeextensiblePattern: Consent
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:consent.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:consent.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:consent.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

This structure is derived from AuditEvent

Summary

Mandatory: 4 elements (10 nested mandatory elements)
Must-Support: 20 elements
Prohibited: 19 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element AuditEvent.agent is sliced based on the value of pattern:type
  • The element AuditEvent.entity is sliced based on the value of pattern:type
  • The element AuditEvent.entity.detail is sliced based on the value of pattern:type

 

Other representations of profile: CSV, Excel, Schematron