Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.us.consent-management.r4) and R4B (hl7.fhir.us.consent-management.r4b) are available.
This publication includes IP covered under the following statements.
There are no Global profiles defined
This IG Contains the following dependencies on other IGs.
IG | Package | FHIR | Comment |
---|---|---|---|
Scalable Consent Management | hl7.fhir.us.consent-management#0.1.0 | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#6.0.2 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.1.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack |
US Core Implementation Guide | hl7.fhir.us.core#6.1.0 | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#5.0.0 | R4 | |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | |
Bulk Data Access IG | hl7.fhir.uv.bulkdata#2.0.0 | R4 | |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.1.0 | R4 | |
VSAC | us.nlm.vsac#0.11.0 | R4 | |
Structured Data Capture | hl7.fhir.uv.sdc#3.0.0 | R4 | |
PHINVads | us.cdc.phinvads#0.12.0 | R4 | |
IHE FormatCode Vocabulary | ihe.formatcode.fhir#1.1.0 | R4 | |
Subscriptions R5 Backport | hl7.fhir.uv.subscriptions-backport.r4#1.1.0 | R4 |
Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00) |
Package hl7.fhir.uv.extensions.r4#1.0.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00) |
Package hl7.fhir.uv.bulkdata#2.0.0 FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00) |
Package hl7.fhir.uv.sdc#3.0.0 The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. |
Package ihe.formatcode.fhir#1.1.0 Implementation Guide for IHE defined FormatCode vocabulary. (built Thu, Feb 24, 2022 16:55-0600-06:00) |
Package hl7.fhir.us.core#6.1.0 The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Fri, Jun 30, 2023 14:02+0000+00:00) |
Package hl7.fhir.uv.subscriptions-backport.r4#1.1.0 The Subscription R5 Backport Implementation Guide enables servers running versions of FHIR earlier than R5 to implement a subset of R5 Subscriptions in a standardized way. (built Wed, Jan 11, 2023 15:34+1100+11:00) |
These value sets are used in this implementation guide:
URL | Version | Name / Title | Status | Flags | Source | References |
---|---|---|---|---|---|---|
http://hl7.org/fhir/ValueSet/audit-entity-type | 4.0.1 | AuditEventEntityType Audit event entity type | draft / trial-use / FMM3 | A | THO, hl7.fhir.r4.core | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/audit-event-action | 4.0.1 | AuditEventAction AuditEventAction | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/audit-event-outcome | 4.0.1 | AuditEventOutcome AuditEventOutcome | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/audit-event-sub-type | 4.0.1 | AuditEventSub-Type Audit Event Sub-Type | active / trial-use / FMM3 | A E | DICOM, hl7.fhir.r4.core | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/audit-event-type | 4.0.1 | AuditEventID Audit Event ID | active / trial-use / FMM3 | A E | DICOM, THO | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/audit-source-type | 4.0.1 | AuditEventSourceType Audit Event Source Type | active / trial-use / FMM3 | A | THO | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/c80-facilitycodes | 4.0.1 | FacilityTypeCodeValueSet Facility Type Code Value Set | active / draft / FMM1 | E | SCT | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/c80-practice-codes | 4.0.1 | PracticeSettingCodeValueSet Practice Setting Code Value Set | active / draft / FMM1 | E | SCT | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/composition-status | 4.0.1 | CompositionStatus CompositionStatus | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/consent-action | 4.0.1 | ConsentActionCodes Consent Action Codes | draft / draft / FMM1 | A | THO | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-category | 4.0.1 | ConsentCategoryCodes Consent Category Codes | draft / trial-use / FMM2 | A E V | LOINC, THO | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-content-class | 4.0.1 | ConsentContentClass Consent Content Class | draft / trial-use / FMM2 | A E V | Other, hl7.fhir.r4.core | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-content-code | 4.0.1 | ConsentContentCodes Consent Content Codes | draft / draft / FMM1:experimental | A | LOINC | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-data-meaning | 4.0.1 | ConsentDataMeaning ConsentDataMeaning | draft / trial-use / FMM2 | A | hl7.fhir.r4.core | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-policy | 4.0.1 | ConsentPolicyRuleCodes Consent PolicyRule Codes | draft / trial-use / FMM2 | A | THO | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-provision-type | 4.0.1 | ConsentProvisionType ConsentProvisionType | draft / trial-use / FMM2 | A | hl7.fhir.r4.core | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-scope | 4.0.1 | ConsentScopeCodes Consent Scope Codes | draft / trial-use / FMM2 | A | THO | FASTConsent |
http://hl7.org/fhir/ValueSet/consent-state-codes | 4.0.1 | ConsentState ConsentState | draft / trial-use / FMM2 | A | hl7.fhir.r4.core | FASTConsent |
http://hl7.org/fhir/ValueSet/dicm-405-mediatype | 4.0.1 | MediaTypeCode Media Type Code | active / trial-use / FMM3 | E | DICOM | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/document-classcodes | 4.0.1 | DocumentClassValueSet Document Class Value Set | active / draft / FMM1 | E | LOINC | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/document-reference-status | 4.0.1 | DocumentReferenceStatus DocumentReferenceStatus | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/document-relationship-type | 4.0.1 | DocumentRelationshipType DocumentRelationshipType | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/formatcodes | 4.0.1 | DocumentReferenceFormatCodeSet DocumentReference Format Code Set | active | A | Other | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/languages | 4.0.1 | CommonLanguages Common Languages | draft / trial-use / FMM3 | E | hl7.terminology.r4 | FASTConsentTask, FASTConsentDocumentReference, FASTConsentAuditEvent, FASTConsentProvenance, FASTConsentQuestionnaireResponse, FASTConsent |
http://hl7.org/fhir/ValueSet/mimetypes | 4.0.1 | Mime Types MimeType | active / normative / FMM5 | A | Other | FASTConsentDocumentReference |
http://hl7.org/fhir/ValueSet/network-type | 4.0.1 | AuditEventAgentNetworkType AuditEventAgentNetworkType | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/object-lifecycle-events | 5.1.0 | ObjectLifecycleEvents ObjectLifecycleEvents | active / trial-use / FMM3 | A | THO | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/object-role | 4.0.1 | AuditEventEntityRole AuditEventEntityRole | draft / trial-use / FMM3 | A | THO | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/participation-role-type | 4.0.1 | ParticipationRoleType ParticipationRoleType | draft / trial-use / FMM3 | A I E | DICOM, THO, THO (V3) | FASTConsentAuditEvent |
http://hl7.org/fhir/ValueSet/performer-role | 4.0.1 | ProcedurePerformerRoleCodes Procedure Performer Role Codes | draft / draft / FMM1 | I | SCT | FASTConsentTask |
http://hl7.org/fhir/ValueSet/provenance-activity-type | 4.0.1 | ProvenanceActivityType Provenance activity type | draft / trial-use / FMM3 | A E | THO (V3) | FASTConsentProvenance |
http://hl7.org/fhir/ValueSet/provenance-agent-type | 4.0.1 | ProvenanceParticipantType Provenance participant type | draft / draft / FMM1 | A | THO | FASTConsentProvenance |
http://hl7.org/fhir/ValueSet/provenance-entity-role | 4.0.1 | ProvenanceEntityRole ProvenanceEntityRole | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentProvenance |
http://hl7.org/fhir/ValueSet/questionnaire-answers | 4.0.1 | QuestionnaireAnswerCodes Questionnaire Answer Codes | draft / draft / FMM1 | A | SCT | FASTConsentQuestionnaireResponse |
http://hl7.org/fhir/ValueSet/questionnaire-answers-status | 4.0.1 | QuestionnaireResponseStatus QuestionnaireResponseStatus | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentQuestionnaireResponse |
http://hl7.org/fhir/ValueSet/request-priority | 4.0.1 | RequestPriority Request priority | draft / trial-use / FMM3 | A | hl7.fhir.r4.core | FASTConsentTask |
http://hl7.org/fhir/ValueSet/resource-types | 4.0.1 | ResourceType ResourceType | active / normative / FMM5 | A | hl7.fhir.r4.core | FASTConsentProvenance |
http://hl7.org/fhir/ValueSet/security-labels | 4.0.1 | All Security Labels SecurityLabels | active / normative / FMM5 | V | FASTConsentDocumentReference, FASTConsentAuditEvent, FASTConsent | |
http://hl7.org/fhir/ValueSet/security-role-type | 4.0.1 | SecurityRoleType SecurityRoleType | draft / trial-use / FMM2 | A I E | DICOM, THO, THO (V3) | FASTConsentAuditEvent, FASTConsentProvenance, FASTConsent |
http://hl7.org/fhir/ValueSet/task-code | 4.0.1 | TaskCode Task Codes | active / draft / FMM1 | A | hl7.fhir.r4.core | FASTConsentTask |
http://hl7.org/fhir/ValueSet/task-intent | 4.0.1 | TaskIntent TaskIntent | draft / trial-use / FMM2 | A E | hl7.fhir.r4.core | FASTConsentTask |
http://hl7.org/fhir/ValueSet/task-status | 4.0.1 | TaskStatus TaskStatus | draft / trial-use / FMM2 | A | hl7.fhir.r4.core | FASTConsentTask |
http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | 6.1.0 | USCoreDocumentReferenceCategory US Core DocumentReference Category | active | A | hl7.fhir.us.core | FASTConsentDocumentReference |
http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type | 6.1.0 | USCoreDocumentReferenceType US Core DocumentReference Type | active | I E | LOINC, THO (V3) | FASTConsentDocumentReference |
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | 6.1.0 | USCoreProvenancePaticipantTypeCodes US Core Provenance Participant Type Codes | active | A | THO, hl7.fhir.us.core | FASTConsentProvenance |
http://terminology.hl7.org/ValueSet/v3-ActCode | 3.0.0 | ActCode v3 Code System ActCode | active / FMM1 | A | THO (V3) | FASTConsentDocumentReference |
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse | 3.1.0 | PurposeOfUse PurposeOfUse | active | I | THO (V3) | FASTConsentAuditEvent, FASTConsentProvenance, FASTConsent |
These code systems are used in this implementation guide:
URL | Version | Name / Title | Status | Flags | Count | References |
---|---|---|---|---|---|---|
http://dicom.nema.org/resources/ontology/DCM | 01 | DICOM Controlled Terminology Definitions | active | flat | 3156 (complete) | SecurityRoleType, Media Type Code, ParticipationRoleType, Audit Event ID, Audit Event Sub-Type |
http://hl7.org/fhir/CodeSystem/task-code | 4.0.1 | TaskCode Task Codes | active / draft / FMM1 | flat | 7 (complete) | Task Codes |
http://hl7.org/fhir/audit-event-action | 4.0.1 | AuditEventAction AuditEventAction | draft / trial-use / FMM3 | flat | 5 (complete) | AuditEventAction |
http://hl7.org/fhir/audit-event-outcome | 4.0.1 | AuditEventOutcome AuditEventOutcome | draft / trial-use / FMM3 | flat | 4 (complete) | AuditEventOutcome |
http://hl7.org/fhir/composition-status | 4.0.1 | CompositionStatus CompositionStatus | draft / trial-use / FMM3 | flat | 4 (complete) | CompositionStatus |
http://hl7.org/fhir/consent-data-meaning | 4.0.1 | ConsentDataMeaning ConsentDataMeaning | draft / trial-use / FMM2 | flat | 4 (complete) | ConsentDataMeaning |
http://hl7.org/fhir/consent-provision-type | 4.0.1 | ConsentProvisionType ConsentProvisionType | draft / trial-use / FMM2 | flat | 2 (complete) | ConsentProvisionType |
http://hl7.org/fhir/consent-state-codes | 4.0.1 | ConsentState ConsentState | draft / trial-use / FMM2 | flat | 6 (complete) | ConsentState |
http://hl7.org/fhir/document-reference-status | 4.0.1 | DocumentReferenceStatus DocumentReferenceStatus | draft / trial-use / FMM3 | flat | 3 (complete) | DocumentReferenceStatus |
http://hl7.org/fhir/document-relationship-type | 4.0.1 | DocumentRelationshipType DocumentRelationshipType | draft / trial-use / FMM3 | flat | 4 (complete) | DocumentRelationshipType |
http://hl7.org/fhir/network-type | 4.0.1 | AuditEventAgentNetworkType AuditEventAgentNetworkType | draft / trial-use / FMM3 | flat | 5 (complete) | AuditEventAgentNetworkType |
http://hl7.org/fhir/provenance-entity-role | 4.0.1 | ProvenanceEntityRole ProvenanceEntityRole | draft / trial-use / FMM3 | 5 (complete) | ProvenanceEntityRole | |
http://hl7.org/fhir/questionnaire-answers-status | 4.0.1 | QuestionnaireResponseStatus QuestionnaireResponseStatus | draft / trial-use / FMM3 | flat | 5 (complete) | QuestionnaireResponseStatus |
http://hl7.org/fhir/request-intent | 4.0.1 | RequestIntent RequestIntent | draft / trial-use / FMM2 | 9 (complete) | TaskIntent | |
http://hl7.org/fhir/request-priority | 4.0.1 | RequestPriority RequestPriority | draft | flat | 4 (complete) | Request priority |
http://hl7.org/fhir/resource-types | 4.0.1 | ResourceType ResourceType | active / normative / FMM5 | flat | 148 (complete) | Audit event entity type, Consent Content Class, ResourceType |
http://hl7.org/fhir/restful-interaction | 4.0.1 | FHIR Restful Interactions | active / normative / FMM5 | is-a | 17 (complete) | Audit Event Sub-Type |
http://hl7.org/fhir/task-intent | 4.0.1 | TaskIntent TaskIntent | draft / trial-use / FMM2 | flat | 1 (complete) | TaskIntent |
http://hl7.org/fhir/task-status | 4.0.1 | TaskStatus TaskStatus | draft / trial-use / FMM2 | flat | 12 (complete) | TaskStatus |
http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | 6.1.0 | USCoreDocumentReferencesCategoryCodes US Core DocumentReferences Category Codes | active | flat | 1 (complete) | US Core DocumentReference Category |
http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type | 6.1.0 | USCoreProvenancePaticipantTypeExtensionCodes US Core Provenance Participant Type Extension Codes | active | flat | 1 (complete) | US Core Provenance Participant Type Codes |
http://loinc.org | 3.1.0 | LOINC Logical Observation Identifiers, Names and Codes (LOINC) | active | flat | 0 (not-present) | Consent Content Codes, Document Class Value Set, Consent Category Codes, US Core DocumentReference Type |
http://snomed.info/sct | SNOMED_CT SNOMED CT (all versions) | active | is-a flat compositional | 0 (not-present) | Questionnaire Answer Codes, Procedure Performer Role Codes, Practice Setting Code Value Set, Facility Type Code Value Set | |
http://terminology.hl7.org/CodeSystem/audit-entity-type | 1.0.1 | AuditEventEntityType Audit event entity type | active / FMM3 | flat | 4 (complete) | Audit event entity type |
http://terminology.hl7.org/CodeSystem/audit-event-type | 1.0.0 | AuditEventID Audit Event ID | active / FMM3 | flat | 5 (complete) | Audit Event ID |
http://terminology.hl7.org/CodeSystem/consentaction | 1.0.1 | ConsentActionCodes Consent Action Codes | active / FMM1 | flat | 5 (complete) | Consent Action Codes |
http://terminology.hl7.org/CodeSystem/consentcategorycodes | 1.0.1 | ConsentCategoryCodes Consent Category Codes | active / FMM2 | is-a flat | 9 (complete) | Consent Category Codes |
http://terminology.hl7.org/CodeSystem/consentpolicycodes | 3.0.1 | ConsentPolicyRuleCodes Consent PolicyRule Codes | active / FMM2 | is-a flat | 27 (complete) | Consent PolicyRule Codes |
http://terminology.hl7.org/CodeSystem/consentscope | 2.0.1 | ConsentScopeCodes Consent Scope Codes | active / FMM2 | flat | 4 (complete) | Consent Scope Codes |
http://terminology.hl7.org/CodeSystem/contractsignertypecodes | 1.0.1 | ContractSignerTypeCodes Contract Signer Type Codes | active | flat | 48 (complete) | SecurityRoleType, ParticipationRoleType |
http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle | 2.0.0 | DicomAuditMessageRecordLifecycleEvents DICOM Audit Message Record Lifecycle Events | active | flat | 15 (complete) | ObjectLifecycleEvents |
http://terminology.hl7.org/CodeSystem/extra-security-role-type | 1.0.1 | SecurityRoleType Security Role Type | active: experimental | flat | 5 (complete) | SecurityRoleType, ParticipationRoleType |
http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle | 1.0.0 | Iso_21089_2017_Health_Record_Lifecycle_Events ISO 21089 2017 Health Record Lifecycle Events | active | flat | 27 (complete) | ObjectLifecycleEvents, Audit Event ID |
http://terminology.hl7.org/CodeSystem/object-role | 1.0.1 | AuditEventEntityRole AuditEventEntityRole | active / FMM3 | flat | 24 (complete) | AuditEventEntityRole |
http://terminology.hl7.org/CodeSystem/provenance-participant-type | 1.1.0 | ProvenanceParticipantType Provenance participant type | active / FMM3 | is-a | 12 (complete) | US Core Provenance Participant Type Codes, Provenance participant type |
http://terminology.hl7.org/CodeSystem/security-source-type | 1.0.0 | AuditEventSourceType Audit Event Source Type | active / FMM3 | flat | 9 (complete) | Audit Event Source Type |
http://terminology.hl7.org/CodeSystem/v3-ActCode | 9.0.0 | ActCode ActCode | active | is-a | 1302 (complete) | v3 Code System ActCode, Provenance activity type |
http://terminology.hl7.org/CodeSystem/v3-ActReason | 3.1.0 | ActReason ActReason | active | is-a flat | 298 (complete) | PurposeOfUse |
http://terminology.hl7.org/CodeSystem/v3-DataOperation | 5.0.0 | DataOperation DataOperation | active | is-a | 21 (complete) | Provenance activity type |
http://terminology.hl7.org/CodeSystem/v3-DocumentCompletion | 3.0.0 | DocumentCompletion DocumentCompletion | active | is-a flat | 9 (complete) | Provenance activity type |
http://terminology.hl7.org/CodeSystem/v3-NullFlavor | 3.0.0 | NullFlavor NullFlavor | active | is-a flat | 17 (complete) | US Core DocumentReference Type |
http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction | 3.0.0 | ParticipationFunction ParticipationFunction | active | is-a | 49 (complete) | SecurityRoleType, ParticipationRoleType |
http://terminology.hl7.org/CodeSystem/v3-ParticipationType | 5.0.0 | ParticipationType ParticipationType | active | is-a | 62 (complete) | SecurityRoleType, ParticipationRoleType, Provenance activity type |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 4.0.0 | RoleClass RoleClass | active | is-a | 112 (complete) | SecurityRoleType, ParticipationRoleType |
http://terminology.hl7.org/CodeSystem/v3-RoleCode | 3.0.0 | RoleCode RoleCode | active | is-a flat | 413 (complete) | SecurityRoleType, ParticipationRoleType |
urn:ietf:bcp:47 | 2.0.1 | Ietf3066 Tags for the Identification of Languages | active | flat | 0 (not-present) | Common Languages |