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-server.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/hlnconsulting/uscdi-scd-ig/CapabilityStatement-uscdi-scd-server.html
URLhttp://hl7.org/fhir/us/uscdi-scd/CapabilityStatement/uscdi-scd-server
Version0.1.0
Statusactive
Date2025-01-01
NameUSCDISCDServerCapabilityStatement
TitleUSCDI-SCD Server CapabilityStatement
Realmus
Authorityhl7
DescriptionMinimum server capabilities for systems conformant with the USCDI + Sickle Cell Disease Implementation Guide. Servers SHALL implement US Core Server requirements and additionally support USCDI-SCD profiles. TODO: Complete interaction lists, search parameters, and _include support.
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-allergyintoleranceUSCDI-SCD AllergyIntolerance
hl7.fhir.us.uscdi-scd#currentuscdi-scd-biologicallyderivedproductUSCDI-SCD BiologicallyDerivedProduct
hl7.fhir.us.uscdi-scd#currentuscdi-scd-careplanUSCDI-SCD CarePlan
hl7.fhir.us.uscdi-scd#currentuscdi-scd-condition-encounter-diagnosisUSCDI-SCD Condition Encounter Diagnosis
hl7.fhir.us.uscdi-scd#currentuscdi-scd-condition-problemsUSCDI-SCD Condition Problems and Health Concerns
hl7.fhir.us.uscdi-scd#currentuscdi-scd-encounterUSCDI-SCD Encounter
hl7.fhir.us.uscdi-scd#currentuscdi-scd-laboratory-resultUSCDI-SCD Laboratory Result
hl7.fhir.us.uscdi-scd#currentuscdi-scd-locationUSCDI-SCD Location
hl7.fhir.us.uscdi-scd#currentuscdi-scd-medicationUSCDI-SCD Medication
hl7.fhir.us.uscdi-scd#currentuscdi-scd-organizationUSCDI-SCD Organization
hl7.fhir.us.uscdi-scd#currentuscdi-scd-patientUSCDI-SCD Patient
hl7.fhir.us.uscdi-scd#currentuscdi-scd-practitionerUSCDI-SCD Practitioner
hl7.fhir.us.uscdi-scd#currentuscdi-scd-practitionerroleUSCDI-SCD PractitionerRole
hl7.fhir.us.uscdi-scd#currentuscdi-scd-procedureUSCDI-SCD Procedure
hl7.fhir.us.uscdi-scd#currentuscdi-scd-servicerequestUSCDI-SCD ServiceRequest
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-server

USCDI-SCD Server 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: server

USCDI-SCD Server SHALL:

  1. Support all US Core Server requirements (US Core 8.0.1 CapabilityStatement)
  2. Support the USCDI-SCD profiles listed below
  3. Support SMART on FHIR (standalone launch, EHR launch)
  4. Support TLS 1.2 or higher for all connections
  5. Support FHIR AuditEvent for access logging

TODO: Add specific search parameter requirements for SCD use cases:

  • Patient: search by identifier, name, birthdate, gender
  • Condition: search by patient, code (SCD D57.x codes), category
  • Observation: search by patient, code (HbS%, ferritin, SpO2), date
  • Procedure: search by patient, code (transfusion), date
  • BiologicallyDerivedProduct: search by patient, request, status

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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHALLbirthdatedate
 

Resource Conformance: unspecified Practitioner

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

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
 

Resource Conformance: unspecified PractitionerRole

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Organization

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Location

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Encounter

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

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLdatedate
SHALLclasstoken
 

Resource Conformance: unspecified Condition

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcodetoken
SHALLcategorytoken
 

Resource Conformance: unspecified AllergyIntolerance

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified CarePlan

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified ServiceRequest

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Medication

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

Interaction summary
  • Supports read, search-type.

Resource Conformance: unspecified Procedure

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

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcodetoken
SHALLdatedate
 

Resource Conformance: unspecified Observation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcodetoken
SHALLdatedate
SHALLcategorytoken
 

Resource Conformance: unspecified BiologicallyDerivedProduct

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

BiologicallyDerivedProduct support is RECOMMENDED (SHOULD) for systems that manage blood product transfusion records for SCD patients. Systems that do not manage transfusion records MAY omit this resource. TODO: Define search parameters for BiologicallyDerivedProduct.


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "uscdi-scd-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/us/uscdi-scd/CapabilityStatement/uscdi-scd-server",
  "version": "0.1.0",
  "name": "USCDISCDServerCapabilityStatement",
  "title": "USCDI-SCD Server 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 server capabilities for systems conformant with the USCDI + Sickle\nCell Disease Implementation Guide. Servers SHALL implement US Core Server\nrequirements and additionally support USCDI-SCD profiles.\n\nTODO: Complete interaction lists, search parameters, and _include support.",
  "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": "server",
      "documentation": "USCDI-SCD Server SHALL:\n1. Support all US Core Server requirements (US Core 8.0.1 CapabilityStatement)\n2. Support the USCDI-SCD profiles listed below\n3. Support SMART on FHIR (standalone launch, EHR launch)\n4. Support TLS 1.2 or higher for all connections\n5. Support FHIR AuditEvent for access logging\n\nTODO: Add specific search parameter requirements for SCD use cases:\n  - Patient: search by identifier, name, birthdate, gender\n  - Condition: search by patient, code (SCD D57.x codes), category\n  - Observation: search by patient, code (HbS%, ferritin, SpO2), date\n  - Procedure: search by patient, code (transfusion), date\n  - BiologicallyDerivedProduct: search by patient, request, status",
      "resource": [
        {
          "type": "Patient",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "token"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "birthdate",
              "type": "date"
            }
          ]
        },
        {
          "type": "Practitioner",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-practitioner",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "token"
            }
          ]
        },
        {
          "type": "PractitionerRole",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-practitionerrole",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-organization",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Location",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-location",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Encounter",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-encounter",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "date",
              "type": "date"
            },
            {
              "name": "class",
              "type": "token"
            }
          ]
        },
        {
          "type": "Condition",
          "supportedProfile": [
            "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-condition-encounter-diagnosis",
            "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-condition-problems"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "code",
              "type": "token"
            },
            {
              "name": "category",
              "type": "token"
            }
          ]
        },
        {
          "type": "AllergyIntolerance",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-allergyintolerance",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "CarePlan",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-careplan",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "ServiceRequest",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-servicerequest",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Medication",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-medication",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        },
        {
          "type": "Procedure",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-procedure",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "code",
              "type": "token"
            },
            {
              "name": "date",
              "type": "date"
            }
          ]
        },
        {
          "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"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "code",
              "type": "token"
            },
            {
              "name": "date",
              "type": "date"
            },
            {
              "name": "category",
              "type": "token"
            }
          ]
        },
        {
          "type": "BiologicallyDerivedProduct",
          "profile": "http://hl7.org/fhir/us/uscdi-scd/StructureDefinition/uscdi-scd-biologicallyderivedproduct",
          "documentation": "BiologicallyDerivedProduct support is RECOMMENDED (SHOULD) for systems that\nmanage blood product transfusion records for SCD patients. Systems that do\nnot manage transfusion records MAY omit this resource.\nTODO: Define search parameters for BiologicallyDerivedProduct.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        }
      ]
    }
  ]
}