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

FHIR IG analytics

Packagehl7.fhir.us.uscdi-scd
Resource TypeCapabilityStatement
IdCapabilityStatement-uscdi-scd-client.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/hlnconsulting/uscdi-scd-ig/CapabilityStatement-uscdi-scd-client.html
URLhttp://hl7.org/fhir/us/uscdi-scd/CapabilityStatement/uscdi-scd-client
Version0.1.0
Statusactive
Date2025-01-01
NameUSCDISCDClientCapabilityStatement
TitleUSCDI-SCD Client CapabilityStatement
Realmus
Authorityhl7
DescriptionMinimum client capabilities for systems conformant with the USCDI + Sickle Cell Disease Implementation Guide. Clients SHALL implement US Core Client requirements and additionally be capable of consuming USCDI-SCD profile data. TODO: Complete interaction lists and document client processing requirements.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
hl7.fhir.us.core#currenthl7.fhir.us.coreUS Core Implementation Guide
hl7.fhir.us.uscdi-scd#currenthl7.fhir.us.uscdi-scdUSCDI + Sickle Cell Disease Implementation Guide
StructureDefinition
hl7.fhir.us.uscdi-scd#currentuscdi-scd-biologicallyderivedproductUSCDI-SCD BiologicallyDerivedProduct
hl7.fhir.us.uscdi-scd#currentuscdi-scd-laboratory-resultUSCDI-SCD Laboratory Result
hl7.fhir.us.uscdi-scd#currentuscdi-scd-patientUSCDI-SCD Patient
hl7.fhir.us.uscdi-scd#currentuscdi-scd-vital-signsUSCDI-SCD Vital Signs

Narrative

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

Generated Narrative: CapabilityStatement uscdi-scd-client

USCDI-SCD Client CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Published on: 2025-01-01
  • Published by: HL7 International / Public Health

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.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: client

USCDI-SCD Clients SHALL:

  1. Support all US Core Client requirements
  2. Be capable of requesting and processing all USCDI-SCD profiles
  3. Process all Must Support elements in USCDI-SCD profiles without error
  4. Handle missing data using dataAbsentReason where applicable
  5. Display SCD-relevant clinical data in human-readable form

TODO: Add specific client requirements for SCD workflows.

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: unspecified Patient

Base System Profile
USCDI-SCD Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Observation

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

Resource Conformance: unspecified BiologicallyDerivedProduct

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

Client SHOULD support retrieval and display of blood product information for SCD transfusion history review.


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "uscdi-scd-client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/us/uscdi-scd/CapabilityStatement/uscdi-scd-client",
  "version": "0.1.0",
  "name": "USCDISCDClientCapabilityStatement",
  "title": "USCDI-SCD Client CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2025-01-01",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "name": "HL7 International / Public Health",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.hl7.org/Special/committees/pher"
        },
        {
          "system": "email",
          "value": "pher@lists.HL7.org"
        }
      ]
    },
    {
      "name": "HL7 Public Health Work Group",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        },
        {
          "system": "email",
          "value": "pher@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "Minimum client capabilities for systems conformant with the USCDI + Sickle\nCell Disease Implementation Guide. Clients SHALL implement US Core Client\nrequirements and additionally be capable of consuming USCDI-SCD profile data.\n\nTODO: Complete interaction lists and document client processing requirements.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core",
    "http://hl7.org/fhir/us/uscdi-scd/ImplementationGuide/hl7.fhir.us.uscdi-scd"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "USCDI-SCD Clients SHALL:\n1. Support all US Core Client requirements\n2. Be capable of requesting and processing all USCDI-SCD profiles\n3. Process all Must Support elements in USCDI-SCD profiles without error\n4. Handle missing data using dataAbsentReason where applicable\n5. Display SCD-relevant clinical data in human-readable form\n\nTODO: Add specific client requirements for SCD workflows.",
      "resource": [
        {
          "type": "Patient",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Observation",
          "supportedProfile": [
            "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-laboratory-result",
            "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-vital-signs"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "BiologicallyDerivedProduct",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-biologicallyderivedproduct",
          "documentation": "Client SHOULD support retrieval and display of blood product information for SCD transfusion history review.",
          "interaction": [
            {
              "code": "read"
            }
          ]
        }
      ]
    }
  ]
}