StructureDefinition-IHE.BasicAudit.Read

Sourceihe.iti.balp#current:Basic Audit Log Patterns (BALP) (v4.0.1)
resourceTypeStructureDefinition
idIHE.BasicAudit.Read
canonicalhttps://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Read
version1.1.2
statusactive
publisherIHE IT Infrastructure Technical Committee
nameRead
titleBasic AuditEvent for a successful Read
date2023-07-28T13:59:05+00:00
descriptionA basic AuditEvent profile for when a RESTful Read action happens successfully. - Given a Resource Read is requested - And that resource does not have a Patient subject or is otherwise associated with a Patient - when the resource is Patient specific then [PatientRead](StructureDefinition-IHE.BasicAudit.PatientRead.html) is used - And the request is authorized - Authorization failures should follow [FHIR core Access Denied](http://hl7.org/fhir/security.html#AccessDenied) - When successful - Note a failure AuditEvent may follow this pattern, but would not be a successful outcome and should have an OperationOutcome - Then the AuditEvent recorded will conform
jurisdictionsuv
fhirVersion4.0.1
kindresource
abstractfalse
sdTtypeAuditEvent
derivationconstraint
basehttp://hl7.org/fhir/StructureDefinition/AuditEvent
Usages
Name Flags Card. Type Description & Constraints doco
. . AuditEvent AuditEvent
. . . type 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 1 .. Slice: Unordered, Open by value:$this
. . . . subtype:anyRead 0..1 Required Pattern: At least the following
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: read
. . . . subtype:anyVread 0..1 Required Pattern: At least the following
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: vread
. . . action Required Pattern: R
. . . outcome Required Pattern: 0
. . . Slices for agent 2 .. Slice: Unordered, Open by pattern:type
. . . . agent:client 1..1
. . . . . type 1.. Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
. . . . . who 1..
. . . . . media .. 0
. . . . . network 1..
. . . . agent:server 1..1
. . . . . type 1.. Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
. . . . . who 1..
. . . . . media .. 0
. . . . . network 1..
. . . . agent:user 0..1
. . . . . type 1.. Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: IRCP
. . . . . role S
. . . . . who 1..
. . . . . name S
. . . . . requestor Required Pattern: true
. . . . . media .. 0
. . . . . network .. 0
. . . . . purposeOfUse S
. . . source S
. . . Slices for entity 1 .. Slice: Unordered, Open by pattern:type
. . . . entity:transaction 0..1
. . . . . what
. . . . . . identifier
. . . . . . . value 1.. the value of X-Request-Id
. . . . . type 1.. Required Pattern: At least the following
. . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
. . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
. . . . entity:data 1..1
. . . . . what 1..
. . . . . type 1.. 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 Binding: RESTful objects role in the event ( required )
. . . . . securityLabel may contain the security labels on the resource returned

doco Documentation for this format

Produced 08 Sep 2023