FHIR IG analytics| Package | hl7.fhir.us.uscdi-scd |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-uscdi-scd-server.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/hlnconsulting/uscdi-scd-ig/CapabilityStatement-uscdi-scd-server.html |
| URL | http://hl7.org/fhir/us/uscdi-scd/CapabilityStatement/uscdi-scd-server |
| Version | 0.1.0 |
| Status | active |
| Date | 2025-01-01 |
| Name | USCDISCDServerCapabilityStatement |
| Title | USCDI-SCD Server CapabilityStatement |
| Realm | us |
| Authority | hl7 |
| Description | Minimum 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. |
| Kind | requirements |
No resources found
| ImplementationGuide | ||
| hl7.fhir.us.core#current | hl7.fhir.us.core | US Core Implementation Guide |
| hl7.fhir.us.uscdi-scd#current | hl7.fhir.us.uscdi-scd | USCDI + Sickle Cell Disease Implementation Guide |
| StructureDefinition | ||
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-allergyintolerance | USCDI-SCD AllergyIntolerance |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-biologicallyderivedproduct | USCDI-SCD BiologicallyDerivedProduct |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-careplan | USCDI-SCD CarePlan |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-condition-encounter-diagnosis | USCDI-SCD Condition Encounter Diagnosis |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-condition-problems | USCDI-SCD Condition Problems and Health Concerns |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-encounter | USCDI-SCD Encounter |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-laboratory-result | USCDI-SCD Laboratory Result |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-location | USCDI-SCD Location |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-medication | USCDI-SCD Medication |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-organization | USCDI-SCD Organization |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-patient | USCDI-SCD Patient |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-practitioner | USCDI-SCD Practitioner |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-practitionerrole | USCDI-SCD PractitionerRole |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-procedure | USCDI-SCD Procedure |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-servicerequest | USCDI-SCD ServiceRequest |
| hl7.fhir.us.uscdi-scd#current | uscdi-scd-vital-signs | USCDI-SCD Vital Signs |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement uscdi-scd-server
application/fhir+json, application/fhir+xmlNote 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.
serverUSCDI-SCD Server SHALL:
TODO: Add specific search parameter requirements for SCD use cases:
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincluderead, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | |
| SHALL | name | string | |
| SHALL | birthdate | date |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token |
read, search-type.read, search-type.read, search-type.read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | date | date | |
| SHALL | class | token |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | code | token | |
| SHALL | category | token |
read, search-type.read, search-type.read, search-type.read, search-type.read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | code | token | |
| SHALL | date | date |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | code | token | |
| SHALL | date | date | |
| SHALL | category | token |
read, search-type.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.
{
"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"
}
]
}
]
}
]
}