XIG: CapabilityStatement/FHIRServer

FHIR IG Statistics: CapabilityStatement/FHIRServer

Package	hl7.fhir.uv.radiation-dose-summary
Resource Type	CapabilityStatement
Id	FHIRServer
FHIR Version	R4
Source	http://hl7.org/fhir/uv/radiation-dose-summary/https://build.fhir.org/ig/HL7/fhir-radiation-dose-summary-ig/CapabilityStatement-FHIRServer.html
URL	http://hl7.org/fhir/uv/radiation-dose-summary/CapabilityStatement/FHIRServer
Version	1.0.0
Status	active
Date	2021-06-28
Name	RDSC_FHIRServer
Title	FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors
Realm	uv
Authority	hl7
Description	Defines the operations requirement for FHIR server actor
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.radiation-dose-summary	Radiation Dose Summary for Diagnostic Procedures on FHIR

Narrative

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

Generated Narrative: CapabilityStatement FHIRServer

FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors

Implementation Guide Version: 1.0.0
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats:
Published on: 2021-06-28
Published by: HL7 International / Imaging Integration

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

http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary

FHIR RESTful Capabilities

Mode: `server`

Description of the needed resources to be supported by the FHIR server, and the different possible interactions.

Summary of System-wide Interactions

Supports the transactioninteraction.
Supports the search-systeminteraction.

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 Type	R	S	C	Searches
Patient	y	y	y	identifier, given
Practitioner	y	y	y	identifier, given
ImagingStudy	y	y	y	patient
Device	y	y	y	manufacturer
Observation	y	y	y	identifier, code, patient, device, part-of, date

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

SHALL support read, search-type.
MAY support create.

Documentation

Search and Read of patient needs to be available on FHIR server, and patient create can be activated based on the covered use case.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`
SHOULD	given	`string`

Resource Conformance: SHALL Practitioner

Core FHIR Resource
Practitioner

Reference Policy

Interaction summary

SHALL support read, search-type.
MAY support create.

Documentation

Search and Read of practitioner shall be supported.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`
SHOULD	given	`string`

Resource Conformance: SHALL ImagingStudy

Core FHIR Resource
ImagingStudy

Reference Policy

Interaction summary

SHALL support read, search-type.
MAY support create.

Documentation

Search and Read of ImagingStudy shall be supported.

Search Parameters

Conformance	Parameter	Type	Documentation
MAY	patient	`reference`

Resource Conformance: SHALL Device

Core FHIR Resource
Device

Reference Policy

Interaction summary

SHALL support read, search-type.
MAY support create.

Documentation

Search and Read of Device shall be supported.

Search Parameters

Conformance	Parameter	Type	Documentation
MAY	manufacturer	`token`

Resource Conformance: SHALL Observation

Core FHIR Resource
Observation

Reference Policy

Interaction summary

SHALL support create, read, search-type.

Documentation

Create, Search and read Radiation Summary observations shall be supported.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`
SHALL	code	`token`	Search based on identifiers of radiation dose summary like Accession Number
SHALL	patient	`reference`	Search based on patient identifier
SHALL	device	`token`	Search based on modality identifiers
SHALL	part-of	`reference`	Search based on ImagingStudy
SHALL	date	`date`	Search based on Radiation Summary effective dateTime, can be used to search for radiation through a period of time

FHIR Document Capabilities

Mode	Document Resource Profile	Documentation
consumer	Radiation Summary Report	Documents related to Radiation Summary Report profile.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "FHIRServer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "ii"
    },
    {
      "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/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"
          }
        ]
      }
    },
    {
      "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/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/radiation-dose-summary/CapabilityStatement/FHIRServer",
  "version": "1.0.0",
  "name": "RDSC_FHIRServer",
  "title": "FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors",
  "status": "active",
  "date": "2021-06-28",
  "publisher": "HL7 International / Imaging Integration",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/imagemgt"
        }
      ]
    },
    {
      "name": "HL7 Imaging Integration Workgroup",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/imagemgt"
        }
      ]
    },
    {
      "name": "Abderrazek Boufahja",
      "telecom": [
        {
          "system": "email",
          "value": "abderrazek.boufahja@gehealthcare.com"
        }
      ]
    }
  ],
  "description": "Defines the operations requirement for FHIR server actor",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/radiation-dose-summary/ImplementationGuide/hl7.fhir.uv.radiation-dose-summary"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource": [
        {
          "type": "Patient",
          "documentation": "Search and Read of patient needs to be available on FHIR server, and patient create can be activated based on the covered use case.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "type": "string"
            }
          ]
        },
        {
          "type": "Practitioner",
          "documentation": "Search and Read of practitioner shall be supported.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "type": "string"
            }
          ]
        },
        {
          "type": "ImagingStudy",
          "documentation": "Search and Read of ImagingStudy shall be supported.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "patient",
              "type": "reference"
            }
          ]
        },
        {
          "type": "Device",
          "documentation": "Search and Read of Device shall be supported.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "manufacturer",
              "type": "token"
            }
          ]
        },
        {
          "type": "Observation",
          "documentation": "Create, Search and read Radiation Summary observations shall be supported.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "type": "token",
              "documentation": "Search based on identifiers of radiation dose summary like Accession Number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "reference",
              "documentation": "Search based on patient identifier"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "device",
              "type": "token",
              "documentation": "Search based on modality identifiers"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "part-of",
              "type": "reference",
              "documentation": "Search based on ImagingStudy"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "type": "date",
              "documentation": "Search based on Radiation Summary effective dateTime, can be used to search for radiation through a period of time"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ]
    }
  ],
  "document": [
    {
      "mode": "consumer",
      "documentation": "Documents related to Radiation Summary Report profile.",
      "profile": "http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/radiation-summary-report"
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/FHIRServer

Resources that use this resource

Resources that this resource uses

Narrative

FHIR Server supporting FHIR operations in order to interact with RDSC and RDSP Actors

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Patient

Resource Conformance: SHALL Practitioner

Resource Conformance: SHALL ImagingStudy

Resource Conformance: SHALL Device

Resource Conformance: SHALL Observation

FHIR Document Capabilities

Source

Mode: `server`