FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.davinci-pdex
Resource TypeCodeSystem
IdCodeSystem-pdex-consent-api-purpose.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/davinci-epdx/CodeSystem-pdex-consent-api-purpose.html
URLhttp://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose
Version2.2.0
Statusactive
Date2026-03-19T14:08:32+00:00
NamePDexConsentApiPurposeCS
TitlePDex Consent API Purpose
Realmus
Authorityhl7
DescriptionCodes identifying which CMS-mandated API a Consent resource applies to. Used as a category discriminator to allow systems to locate and distinguish Consent records for Provider Access, Payer-to-Payer, and Patient Access APIs for a given member.
CopyrightUsed by permission of HL7 International, all rights reserved Creative Commons License
Contentcomplete

Resources that use this resource

ValueSet
hl7.fhir.us.davinci-pdex#currentpdex-consent-api-purpose-vsPDex Consent API Purpose Value Set

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: CodeSystem pdex-consent-api-purpose

This case-sensitive code system http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose defines the following codes:

CodeDisplayDefinition
provider-access Provider Access APIConsent record applies to the CMS-mandated Provider Access API (member opt-out of sharing with providers)
payer-to-payer Payer-to-Payer APIConsent record applies to the CMS-mandated Payer-to-Payer API (member authorization for data retrieval by requesting payer)
patient-access Patient Access APIConsent record applies to the CMS-mandated Patient Access API (member authorization for third-party application access)

Source1

{
  "resourceType": "CodeSystem",
  "id": "pdex-consent-api-purpose",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fm"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"
          }
        ]
      }
    },
    {
      "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/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/pdex-consent-api-purpose",
  "version": "2.2.0",
  "name": "PDexConsentApiPurposeCS",
  "title": "PDex Consent API Purpose",
  "status": "active",
  "experimental": false,
  "date": "2026-03-19T14:08:32+00:00",
  "publisher": "HL7 International / Financial Management",
  "contact": [
    {
      "name": "HL7 International / Financial Management",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm"
        },
        {
          "system": "email",
          "value": "fm@lists.HL7.org"
        }
      ]
    },
    {
      "name": "Mark Scrimshire (mark.scrimshire@onyxhealth.io)",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:mark.scrimshire@onyxhealth.io"
        }
      ]
    },
    {
      "name": "HL7 International - Financial Management",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm"
        }
      ]
    }
  ],
  "description": "Codes identifying which CMS-mandated API a Consent resource applies to. Used as a category discriminator to allow systems to locate and distinguish Consent records for Provider Access, Payer-to-Payer, and Patient Access APIs for a given member.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
  "caseSensitive": true,
  "content": "complete",
  "count": 3,
  "concept": [
    {
      "code": "provider-access",
      "display": "Provider Access API",
      "definition": "Consent record applies to the CMS-mandated Provider Access API (member opt-out of sharing with providers)"
    },
    {
      "code": "payer-to-payer",
      "display": "Payer-to-Payer API",
      "definition": "Consent record applies to the CMS-mandated Payer-to-Payer API (member authorization for data retrieval by requesting payer)"
    },
    {
      "code": "patient-access",
      "display": "Patient Access API",
      "definition": "Consent record applies to the CMS-mandated Patient Access API (member authorization for third-party application access)"
    }
  ]
}