FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IHE.BALP.AuditConsumer

Packageihe.iti.balp
TypeCapabilityStatement
IdIHE.BALP.AuditConsumer
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/BALP/https://build.fhir.org/ig/IHE/ITI.BasicAudit/CapabilityStatement-IHE.BALP.AuditConsumer.html
URLhttps://profiles.ihe.net/ITI/BALP/CapabilityStatement/IHE.BALP.AuditConsumer
Version1.1.4-current
Statusactive
Date2022-10-28
NameIHE_BALP_AuditConsumer
TitleIHE BALP Audit Consumer
Realmuv
Authorityihe
DescriptionCapabilityStatement for [Audit Consumer](volume-1.html#152112-audit-consumer) Actor in [BALP](index.html). This CapabilityStatement replicates the requirements that would come from the ATNA **Audit Consumer* actor supporting **ATNA Retrieve Audit Message Option**.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
IHE.BasicAudit.AuthZconsentBasic AuditEvent pattern for when an Authorization permit is decided
IHE.BasicAudit.CreateBasic AuditEvent for a successful Create not related to a Patient
IHE.BasicAudit.DeleteBasic AuditEvent for a successful Delete
IHE.BasicAudit.OAUTHaccessTokenUse.ComprehensiveBasic AuditEvent pattern for when an activity was authorized by an IUA access token
IHE.BasicAudit.OAUTHaccessTokenUse.MinimalBasic AuditEvent pattern for oAuth Opaque
IHE.BasicAudit.OAUTHaccessTokenUse.OpaqueBasic AuditEvent pattern for oAuth Opaque
IHE.BasicAudit.PatientCreateBasic AuditEvent for a successful Create with known Patient subject
IHE.BasicAudit.PatientDeleteBasic AuditEvent for a successful Delete with Patient
IHE.BasicAudit.PatientQueryBasic AuditEvent for a successful Query with Patient
IHE.BasicAudit.PatientReadBasic AuditEvent for a successful Read with a Patient
IHE.BasicAudit.PatientUpdateBasic AuditEvent for a successful Update with a Patient subject
IHE.BasicAudit.PrivacyDisclosure.RecipientAudit Event for a Privacy Disclosure as recorded by a Recipient
IHE.BasicAudit.PrivacyDisclosure.SourceAudit Event for Privacy Disclosure at Source
IHE.BasicAudit.QueryBasic AuditEvent for a successful Query
IHE.BasicAudit.ReadBasic AuditEvent for a successful Read
IHE.BasicAudit.SAMLaccessTokenUse.ComprehensiveBasic AuditEvent pattern for when an activity was authorized by an SAML access token Comprehensive
IHE.BasicAudit.SAMLaccessTokenUse.MinimalBasic AuditEvent pattern for when an activity was authorized by an SAML access token Minimal
IHE.BasicAudit.UpdateBasic AuditEvent for a successful Update
IHE.IUA.71IHE IUA ITI-71 AuditEvent for a successful Get Access Token

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.BALP.AuditConsumer

IHE BALP Audit Consumer

  • Implementation Guide Version: 1.1.4-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-10-28
  • Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

BALP Audit Consumer will query for AuditEvent resources.

Security

ATNA required, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: supported AuditEvent

Core FHIR Resource
AuditEvent
Reference Policy
Interaction summary
  • Supports search-type, read.

Documentation

For Retrieve ATNA Audit Event [ITI-81]. Note that all BALP Content profiles are listed here.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate
SHALLdatedate
SHALLaddressstring
SHALLagent.identifiertoken
SHALLpatient.identifiertoken
SHALLentity.identifiertoken
SHALLentity-typetoken
SHALLentity-roletoken
SHALLsource.identifiertoken
SHALLtypetoken
SHALLsubtypetoken
SHALLoutcometoken
 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.BALP.AuditConsumer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/BALP/CapabilityStatement/IHE.BALP.AuditConsumer",
  "version": "1.1.4-current",
  "name": "IHE_BALP_AuditConsumer",
  "title": "IHE BALP Audit Consumer",
  "status": "active",
  "experimental": false,
  "date": "2022-10-28",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "contact": [
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
        },
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    },
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for [Audit Consumer](volume-1.html#152112-audit-consumer) Actor in [BALP](index.html).\n\nThis CapabilityStatement replicates the requirements that would come from the ATNA **Audit Consumer* actor supporting **ATNA Retrieve Audit Message Option**.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "BALP Audit Consumer will query for AuditEvent resources.",
      "security": {
        "description": "[ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html) required, encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or SMART-on-FHIR"
      },
      "resource": [
        {
          "type": "AuditEvent",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Create",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Read",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Update",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Delete",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Query",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientCreate",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientRead",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientUpdate",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientDelete",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PatientQuery",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.IUA.71",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.OAUTHaccessTokenUse.Comprehensive",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.OAUTHaccessTokenUse.Minimal",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.OAUTHaccessTokenUse.Opaque",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.SAMLaccessTokenUse.Comprehensive",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.SAMLaccessTokenUse.Minimal",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.AuthZconsent",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PrivacyDisclosure.Recipient",
            "https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.PrivacyDisclosure.Source"
          ],
          "documentation": "For Retrieve ATNA Audit Event [ITI-81]. Note that all BALP Content profiles are listed here.",
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "type": "token"
            },
            {
              "name": "_lastUpdated",
              "type": "date"
            },
            {
              "name": "date",
              "type": "date"
            },
            {
              "name": "address",
              "type": "string"
            },
            {
              "name": "agent.identifier",
              "type": "token"
            },
            {
              "name": "patient.identifier",
              "type": "token"
            },
            {
              "name": "entity.identifier",
              "type": "token"
            },
            {
              "name": "entity-type",
              "type": "token"
            },
            {
              "name": "entity-role",
              "type": "token"
            },
            {
              "name": "source.identifier",
              "type": "token"
            },
            {
              "name": "type",
              "type": "token"
            },
            {
              "name": "subtype",
              "type": "token"
            },
            {
              "name": "outcome",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}