ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: ResMed Operation Failed AuditEvent

Basic AuditEvent for a failed REST-ful operation

Usage:

• Derived from this Resource Profile: ResMed Patient Operation Failed AuditEvent
• Examples for this Resource Profile: AuditEvent/practitioner-not-found-audit-event

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
type		1..1	Coding	Restful Operation Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
Slices for subtype	S	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this
subtype:anyOp		1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
outcome	S	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
media		0..0
network		1..1	BackboneElement	Logical network location for application activity
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
type		1..1	CodeableConcept	How agent participated Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
who		1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	OAuth Token Issuer
value		1..1	string	User ID, i.e. OAuth sub claim.
requestor		1..1	boolean	Whether user is initiator Required Pattern: true
policy	S	1..1	uri	JTI (JWT ID)
source
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer		1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
Slices for entity	S	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:transaction		0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
what		1..1	Reference(Resource)	Specific instance of resource
identifier		1..1	Identifier	the value of X-Request-Id
value		1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
entity:outcome		1..1	BackboneElement	Data or objects used
what		1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
role		1..1	Coding	Domain Resource Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
entity:tenantId		0..1	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific instance of resource
reference		0..0
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
entity:traceId		0..1	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific instance of resource
reference		0..0
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Restful Operation Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
Slices for subtype	SΣ	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:anyOp	Σ	1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
recorded	Σ	1..1	instant	Time when the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
requestor	Σ	1..1	boolean	Whether user is initiator
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
network		1..1	BackboneElement	Logical network location for application activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
who	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	OAuth Token Issuer Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	User ID, i.e. OAuth sub claim. Example General: 123456
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
policy	S	1..1	uri	JTI (JWT ID)
source		1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
Slices for entity	SC	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entity:transaction	C	0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Resource)	Specific instance of resource
identifier	Σ	1..1	Identifier	the value of X-Request-Id
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	Σ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
entity:outcome	C	1..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
role		1..1	Coding	Domain Resource Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
entity:tenantId	C	0..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
entity:traceId	C	0..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
AuditEvent.type	extensible	Pattern: rest
AuditEvent.subtype	extensible	AuditEventSub-Type
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole
AuditEvent.agent:ouser.type	extensible	Pattern: UserOauthAgent
AuditEvent.agent:ouser.who.identifier.use	required	IdentifierUse
AuditEvent.source.observer.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.what.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.type	extensible	Pattern: XrequestId
AuditEvent.entity:outcome.type	extensible	Pattern: 2
AuditEvent.entity:outcome.role	extensible	Pattern: 4
AuditEvent.entity:tenantId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:tenantId.type	extensible	Pattern: tenant-id
AuditEvent.entity:traceId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:traceId.type	extensible	Pattern: trace-id

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:outcome, AuditEvent.entity:tenantId, AuditEvent.entity:traceId	Either a name or a query (NOT both) : name.empty() or query.empty()

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Restful Operation Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
Slices for subtype	SΣ	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:anyOp	Σ	1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
action	Σ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		0..1	Period	When the activity occurred
recorded	Σ	1..1	instant	Time when the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
network		1..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	OAuth Token Issuer Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	User ID, i.e. OAuth sub claim. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
location		0..1	Reference(Location)	Where
policy	S	1..1	uri	JTI (JWT ID)
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source		1..1	BackboneElement	Audit Event Reporter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		0..*	Coding	The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
Slices for entity	SC	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:transaction	C	0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	the value of X-Request-Id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:outcome	C	1..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		1..1	Coding	Domain Resource Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:tenantId	C	0..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:traceId	C	0..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
AuditEvent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	extensible	Pattern: rest
AuditEvent.subtype	extensible	AuditEventSub-Type
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.action	required	AuditEventAction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.purposeOfEvent	extensible	PurposeOfUse
AuditEvent.agent.type	extensible	ParticipationRoleType
AuditEvent.agent.role	example	SecurityRoleType
AuditEvent.agent.media	extensible	MediaTypeCode
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole
AuditEvent.agent:clientOrServer.role	example	SecurityRoleType
AuditEvent.agent:clientOrServer.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent:clientOrServer.purposeOfUse	extensible	PurposeOfUse
AuditEvent.agent:ouser.type	extensible	Pattern: UserOauthAgent
AuditEvent.agent:ouser.role	example	SecurityRoleType
AuditEvent.agent:ouser.who.type	extensible	ResourceType
AuditEvent.agent:ouser.who.identifier.use	required	IdentifierUse
AuditEvent.agent:ouser.who.identifier.type	extensible	Identifier Type Codes
AuditEvent.agent:ouser.media	extensible	MediaTypeCode
AuditEvent.agent:ouser.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent:ouser.purposeOfUse	extensible	PurposeOfUse
AuditEvent.source.observer.type	extensible	ResourceType
AuditEvent.source.observer.identifier.use	required	IdentifierUse
AuditEvent.source.observer.identifier.type	extensible	Identifier Type Codes
AuditEvent.source.type	extensible	AuditEventSourceType
AuditEvent.entity.type	extensible	AuditEventEntityType
AuditEvent.entity.role	extensible	AuditEventEntityRole
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity.securityLabel	extensible	All Security Labels
AuditEvent.entity:transaction.what.type	extensible	ResourceType
AuditEvent.entity:transaction.what.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:transaction.type	extensible	Pattern: XrequestId
AuditEvent.entity:transaction.role	extensible	AuditEventEntityRole
AuditEvent.entity:transaction.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:transaction.securityLabel	extensible	All Security Labels
AuditEvent.entity:outcome.type	extensible	Pattern: 2
AuditEvent.entity:outcome.role	extensible	Pattern: 4
AuditEvent.entity:outcome.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:outcome.securityLabel	extensible	All Security Labels
AuditEvent.entity:tenantId.what.type	extensible	ResourceType
AuditEvent.entity:tenantId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:tenantId.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:tenantId.type	extensible	Pattern: tenant-id
AuditEvent.entity:tenantId.role	extensible	AuditEventEntityRole
AuditEvent.entity:tenantId.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:tenantId.securityLabel	extensible	All Security Labels
AuditEvent.entity:traceId.what.type	extensible	ResourceType
AuditEvent.entity:traceId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:traceId.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:traceId.type	extensible	Pattern: trace-id
AuditEvent.entity:traceId.role	extensible	AuditEventEntityRole
AuditEvent.entity:traceId.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:traceId.securityLabel	extensible	All Security Labels

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:outcome, AuditEvent.entity:tenantId, AuditEvent.entity:traceId	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 15 elements (18 nested mandatory elements)
Must-Support: 15 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

• The element AuditEvent.contained is sliced based on the value of type:$this
• The element AuditEvent.subtype is sliced based on the value of value:$this
• 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

Differential View

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
type		1..1	Coding	Restful Operation Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
Slices for subtype	S	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this
subtype:anyOp		1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
outcome	S	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
media		0..0
network		1..1	BackboneElement	Logical network location for application activity
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
type		1..1	CodeableConcept	How agent participated Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
who		1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	OAuth Token Issuer
value		1..1	string	User ID, i.e. OAuth sub claim.
requestor		1..1	boolean	Whether user is initiator Required Pattern: true
policy	S	1..1	uri	JTI (JWT ID)
source
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer		1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
Slices for entity	S	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:transaction		0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
what		1..1	Reference(Resource)	Specific instance of resource
identifier		1..1	Identifier	the value of X-Request-Id
value		1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
entity:outcome		1..1	BackboneElement	Data or objects used
what		1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
role		1..1	Coding	Domain Resource Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
entity:tenantId		0..1	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific instance of resource
reference		0..0
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
entity:traceId		0..1	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific instance of resource
reference		0..0
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
type		1..1	Coding	Type of entity involved Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Restful Operation Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
Slices for subtype	SΣ	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:anyOp	Σ	1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
recorded	Σ	1..1	instant	Time when the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
requestor	Σ	1..1	boolean	Whether user is initiator
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
network		1..1	BackboneElement	Logical network location for application activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
who	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	OAuth Token Issuer Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	User ID, i.e. OAuth sub claim. Example General: 123456
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
policy	S	1..1	uri	JTI (JWT ID)
source		1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
Slices for entity	SC	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entity:transaction	C	0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Resource)	Specific instance of resource
identifier	Σ	1..1	Identifier	the value of X-Request-Id
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	Σ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
entity:outcome	C	1..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
role		1..1	Coding	Domain Resource Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
entity:tenantId	C	0..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
entity:traceId	C	0..1	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
AuditEvent.type	extensible	Pattern: rest
AuditEvent.subtype	extensible	AuditEventSub-Type
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole
AuditEvent.agent:ouser.type	extensible	Pattern: UserOauthAgent
AuditEvent.agent:ouser.who.identifier.use	required	IdentifierUse
AuditEvent.source.observer.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.what.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.type	extensible	Pattern: XrequestId
AuditEvent.entity:outcome.type	extensible	Pattern: 2
AuditEvent.entity:outcome.role	extensible	Pattern: 4
AuditEvent.entity:tenantId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:tenantId.type	extensible	Pattern: tenant-id
AuditEvent.entity:traceId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:traceId.type	extensible	Pattern: trace-id

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:outcome, AuditEvent.entity:tenantId, AuditEvent.entity:traceId	Either a name or a query (NOT both) : name.empty() or query.empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent	C	0..*	AuditEvent	Event record kept for security purposes agent-is-a-resmed-system: Agent
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for contained		1..*	Resource	Contained, inline Resources Slice: Unordered, Open by type:$this
contained:outcome	S	1..*	OperationOutcome	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Restful Operation Binding: AuditEventID (extensible): Type of event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: rest
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
Slices for subtype	SΣ	1..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:anyOp	Σ	1..1	Coding	More specific type/id for the event Binding: TypeRestfulInteraction (required)
action	Σ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		0..1	Period	When the activity occurred
recorded	Σ	1..1	instant	Time when the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: ResMed AuditEvent Outcome ValueSet (required)
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent	S	2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:clientOrServer		2..2	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	How agent participated Binding: ResMed AuditEvent Application Agent Role ValueSet (required)
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
network		1..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:ouser		0..1	BackboneElement	A user agent profile that (sort of) follows the IHE.BasicAudit.OAUTHaccessTokenUse.Minimal profile.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/UserAgentTypes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: UserOauthAgent
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	OAuth Token Issuer Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	User ID, i.e. OAuth sub claim. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
location		0..1	Reference(Location)	Where
policy	S	1..1	uri	JTI (JWT ID)
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source		1..1	BackboneElement	Audit Event Reporter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	1..1	string	The fully qualified domain name of the ResMed system authoring these events.
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identifier of the ResMed system.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://terminology.resmed.com/CodeSystem/resmed-system-identifier
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		0..*	Coding	The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
Slices for entity	SC	1..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type
entity:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:transaction	C	0..1	BackboneElement	An entity representing the client request ID. This is a replication of the same entity found in the IHE BALP profiles.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	Identifier	the value of X-Request-Id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XrequestId
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:outcome	C	1..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(OperationOutcome)	Specific instance of resource
type		1..1	Coding	System Object Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 2
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		1..1	Coding	Domain Resource Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 4
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:tenantId	C	0..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: tenant-id
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
entity:traceId	C	0..1	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific instance of resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://resmed.com/fhir/core/CodeSystem/rmd-auditEventEntityType-cs
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: trace-id
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
AuditEvent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	extensible	Pattern: rest
AuditEvent.subtype	extensible	AuditEventSub-Type
AuditEvent.subtype:anyOp	required	TypeRestfulInteraction
AuditEvent.action	required	AuditEventAction
AuditEvent.outcome	required	ValueSetResMedAuditEventOutcome
AuditEvent.purposeOfEvent	extensible	PurposeOfUse
AuditEvent.agent.type	extensible	ParticipationRoleType
AuditEvent.agent.role	example	SecurityRoleType
AuditEvent.agent.media	extensible	MediaTypeCode
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse
AuditEvent.agent:clientOrServer.type	required	ValueSetResMedAuditEventAppAgentRole
AuditEvent.agent:clientOrServer.role	example	SecurityRoleType
AuditEvent.agent:clientOrServer.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent:clientOrServer.purposeOfUse	extensible	PurposeOfUse
AuditEvent.agent:ouser.type	extensible	Pattern: UserOauthAgent
AuditEvent.agent:ouser.role	example	SecurityRoleType
AuditEvent.agent:ouser.who.type	extensible	ResourceType
AuditEvent.agent:ouser.who.identifier.use	required	IdentifierUse
AuditEvent.agent:ouser.who.identifier.type	extensible	Identifier Type Codes
AuditEvent.agent:ouser.media	extensible	MediaTypeCode
AuditEvent.agent:ouser.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent:ouser.purposeOfUse	extensible	PurposeOfUse
AuditEvent.source.observer.type	extensible	ResourceType
AuditEvent.source.observer.identifier.use	required	IdentifierUse
AuditEvent.source.observer.identifier.type	extensible	Identifier Type Codes
AuditEvent.source.type	extensible	AuditEventSourceType
AuditEvent.entity.type	extensible	AuditEventEntityType
AuditEvent.entity.role	extensible	AuditEventEntityRole
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity.securityLabel	extensible	All Security Labels
AuditEvent.entity:transaction.what.type	extensible	ResourceType
AuditEvent.entity:transaction.what.identifier.use	required	IdentifierUse
AuditEvent.entity:transaction.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:transaction.type	extensible	Pattern: XrequestId
AuditEvent.entity:transaction.role	extensible	AuditEventEntityRole
AuditEvent.entity:transaction.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:transaction.securityLabel	extensible	All Security Labels
AuditEvent.entity:outcome.type	extensible	Pattern: 2
AuditEvent.entity:outcome.role	extensible	Pattern: 4
AuditEvent.entity:outcome.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:outcome.securityLabel	extensible	All Security Labels
AuditEvent.entity:tenantId.what.type	extensible	ResourceType
AuditEvent.entity:tenantId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:tenantId.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:tenantId.type	extensible	Pattern: tenant-id
AuditEvent.entity:tenantId.role	extensible	AuditEventEntityRole
AuditEvent.entity:tenantId.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:tenantId.securityLabel	extensible	All Security Labels
AuditEvent.entity:traceId.what.type	extensible	ResourceType
AuditEvent.entity:traceId.what.identifier.use	required	IdentifierUse
AuditEvent.entity:traceId.what.identifier.type	extensible	Identifier Type Codes
AuditEvent.entity:traceId.type	extensible	Pattern: trace-id
AuditEvent.entity:traceId.role	extensible	AuditEventEntityRole
AuditEvent.entity:traceId.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity:traceId.securityLabel	extensible	All Security Labels

Constraints

Id	Grade	Path(s)	Details	Requirements
agent-is-a-resmed-system	error	AuditEvent	Agent : agent.who.identifier.exists(system = 'http://terminology.resmed.com/CodeSystem/resmed-system-identifier')
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:outcome, AuditEvent.entity:tenantId, AuditEvent.entity:traceId	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 15 elements (18 nested mandatory elements)
Must-Support: 15 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

• The element AuditEvent.contained is sliced based on the value of type:$this
• The element AuditEvent.subtype is sliced based on the value of value:$this
• 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