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

FHIR IG Statistics: OperationDefinition/record-disclosure

Packagehl7.fhir.us.consent-management
Resource TypeOperationDefinition
Idrecord-disclosure
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html
URLhttp://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure
Version0.1.0
Statusactive
Date2025-08-07T19:06:30+00:00
NameRecordDisclosure
TitleRecordDisclosure
Realmus
Authorityhl7
DescriptionThis operation is used to record a disclosure based on a given consent for a given patient with a consent administration service. The parameters are a Consent AuditEvent and a reference to the corresponding Consent resource.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
ConsentAdministrativeServerCapabilitiesConsent Administrative Server Capabilities
ConsentClientCapabilitiesConsent Client Capabilities

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition record-disclosure

URL: [base]/AuditEvent/$recordDisclosure

Input parameters Profile:Record Disclosure Operation Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INdisclosure1..1AuditEvent

An AuditEvent detailing the disclosure (see Input Parameters Profile for conformance)

INconsent1..1Reference (FASTConsent)

A reference to the Consent instance (see Input Parameters Profile for conformance)

OUTreturn0..1OperationOutcome

Optional outcome of the operation call


Source

{
  "resourceType": "OperationDefinition",
  "id": "record-disclosure",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cbcc"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure",
  "version": "0.1.0",
  "name": "RecordDisclosure",
  "title": "RecordDisclosure",
  "status": "active",
  "kind": "operation",
  "date": "2025-08-07T19:06:30+00:00",
  "publisher": "HL7 International / Community Based Collaborative Care",
  "contact": [
    {
      "name": "HL7 International / Community Based Collaborative Care",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cbcc"
        }
      ]
    }
  ],
  "description": "This operation is used to record a disclosure based on a given consent for a given patient with a consent administration service.  The parameters are a Consent AuditEvent and a reference to the corresponding Consent resource.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "code": "recordDisclosure",
  "resource": [
    "AuditEvent"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "http://hl7.org/fhir/us/consent-management/StructureDefinition/RecordDisclosureParameters",
  "parameter": [
    {
      "name": "disclosure",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "An AuditEvent detailing the disclosure (see Input Parameters Profile for conformance)",
      "type": "AuditEvent"
    },
    {
      "name": "consent",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "A reference to the Consent instance (see Input Parameters Profile for conformance)",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Optional outcome of the operation call",
      "type": "OperationOutcome"
    }
  ]
}