FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/CapabilityStatement-mdi-cms-server

Packagehl7.fhir.us.mdi
TypeCapabilityStatement
IdCapabilityStatement-mdi-cms-server
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/mdi/https://build.fhir.org/ig/HL7/fhir-mdi-ig/CapabilityStatement-CapabilityStatement-mdi-cms-server.html
URLhttp://hl7.org/fhir/us/mdi/CapabilityStatement/CapabilityStatement-mdi-cms-server
Version3.0.0-draft
Statusactive
Date2022-07-03
NameCapabilityStatementMdiCmsServer
TitleCapabilityStatement - MDI CMS Server
Realmus
Authorityhl7
DescriptionThis resource describes expected capabilities of an MDI CMS Server which is responsible for providing responses to the queries submitted by a Client. It lists FHIR profiles and search parameters that, at a minimum, should be supported by MDI CMS Servers. MDI CMS Clients have the option of choosing from this list to access necessary data.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

SearchParameter
us-core-location-addressUSCoreLocationAddress
us-core-observation-dateUSCoreObservationDate
us-core-patient-birthdateUSCorePatientBirthdate
us-core-patient-familyUSCorePatientFamily
us-core-patient-givenUSCorePatientGiven
us-core-patient-identifierUSCorePatientIdentifier
us-core-patient-nameUSCorePatientName
StructureDefinition
vrdr-death-dateDeath Date
vrdr-death-locationDeath Location
Bundle-document-mdi-and-edrsBundle - Document MDI and EDRS
Composition-mdi-and-edrsComposition - MDI and EDRS
us-core-patientUS Core Patient Profile

Narrative

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

CapabilityStatement - MDI CMS Server

  • Title:CapabilityStatement - MDI CMS Server
  • Implementation Guide Version: 3.0.0-draft
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: application/fhir+xml; xml; application/fhir+json; json;
  • Published: 2022-07-03
  • Published by: HL7 International / Public Health
  • Status: Active
  • Copyright:

Description:

This resource describes expected capabilities of an MDI CMS Server which is responsible for providing responses to the queries submitted by a Client. It lists FHIR profiles and search parameters that, at a minimum, should be supported by MDI CMS Servers. MDI CMS Clients have the option of choosing from this list to access necessary data.



Jump to:


FHIR Server RESTful Capabilities

Summary of Resource/Profile Capabilities

Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations
Composition read, search-type, Composition - MDI and EDRS, subject, patient, $operation-composition-document
Patient read, search-type, US Core Patient Profile, _id, birthdate, family, given, gender, name,
Location read, search-type, Death Location, address,
Observation read, search-type, Death Date, date,

RESTful Server Capabilities by Resource/Profile:

Composition

Conformance Expectation: SHALL

Supported Profiles:

Composition Interaction Summary:

  • SHALL support read, search-type,

Fetch and Search Criteria:

  • A Server SHALL be capable of a read interaction returning a Composition resource using: GET [base]/Composition/[id]
  • A Server SHALL be capable of a search-type interaction returning Composition resources matching a search query using: GET [base]/Composition/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example
SHALL subject Token GET [base]/Composition?subject=[system]|[code]
SHALL patient Token GET [base]/Composition?patient=[system]|[code]

Patient

Conformance Expectation: SHALL

Supported Profiles:


Fetch and Search Criteria:

  • A Server SHALL be capable of a read interaction returning a Patient resource using: GET [base]/Patient/[id]
  • A Server SHALL be capable of a search-type interaction returning Patient resources matching a search query using: GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example
SHALL _id Token GET [base]/Patient?_id=[id]
SHALL birthdate Date/DateTime GET [base]/Patient?birthdate=[dateTime]
SHALL family String GET [base]/Patient?family=[family]
SHALL given String GET [base]/Patient?given=[given]
SHALL gender Token GET [base]/Patient?gender=[system]|[code]
SHALL name String GET [base]/Patient?name=[name]

Location

Conformance Expectation: SHALL

Supported Profiles:


Fetch and Search Criteria:

  • A Server SHALL be capable of a read interaction returning a Location resource using: GET [base]/Location/[id]
  • A Server SHALL be capable of a search-type interaction returning Location resources matching a search query using: GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example
SHALL address String GET [base]/Location?address=[address]

Observation

Conformance Expectation: SHALL

Supported Profiles:


Fetch and Search Criteria:

  • A Server SHALL be capable of a read interaction returning a Observation resource using: GET [base]/Observation/[id]
  • A Server SHALL be capable of a search-type interaction returning Observation resources matching a search query using: GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example
SHALL date Date/DateTime GET [base]/Observation?date=[dateTime]

FHIR Client RESTful Capabilities

Summary of Resource/Profile Capabilities

Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations
Bundle read, Bundle - Document MDI and EDRS,

RESTful Client Capabilities by Resource/Profile:

Bundle

Conformance Expectation:

Supported Profiles:


Fetch and Search Criteria:

  • A Client (conformance expectation undefined) be capable of a read interaction fetching a Bundle resource using: GET [base]/Bundle/[id]


Messaging

Supported Message(s):

Mode Definition
Receiver MessageDefinition[http://hl7.org/fhir/us/mdi/MessageDefinition/MessageDefinition-toxicology-system|3.0.0-draft]


Documents

Mode Profile Notes
Producer Composition - MDI and EDRS
Consumer Composition - MDI and EDRS

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CapabilityStatement-mdi-cms-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/mdi/ImplementationGuide/hl7.fhir.us.mdi"
          }
        ]
      }
    },
    {
      "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/mdi/ImplementationGuide/hl7.fhir.us.mdi"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/mdi/CapabilityStatement/CapabilityStatement-mdi-cms-server",
  "version": "3.0.0-draft",
  "name": "CapabilityStatementMdiCmsServer",
  "title": "CapabilityStatement - MDI CMS Server",
  "status": "active",
  "experimental": false,
  "date": "2022-07-03",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "name": "HL7 International / Public Health",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description": "This resource describes expected capabilities of an MDI CMS Server which is responsible for providing responses to the queries submitted by a Client. It lists FHIR profiles and search parameters that, at a minimum, should be supported by MDI CMS Servers. MDI CMS Clients have the option of choosing from this list to access necessary data.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "xml",
    "application/fhir+json",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Composition",
          "supportedProfile": [
            "http://hl7.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ],
          "interaction": [
            {
              "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": "subject",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
              "type": "token"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "operation-composition-document",
              "definition": "http://hl7.org/fhir/OperationDefinition/Composition-document"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ],
          "interaction": [
            {
              "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": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "birthdate",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "family",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "given",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "gender",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
              "type": "string"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Location",
          "supportedProfile": [
            "http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-death-location"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ],
          "interaction": [
            {
              "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": "address",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address",
              "type": "string"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Observation",
          "supportedProfile": [
            "http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-death-date"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ],
          "interaction": [
            {
              "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": "date",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
              "type": "date"
            }
          ]
        }
      ]
    },
    {
      "mode": "client",
      "resource": [
        {
          "type": "Bundle",
          "supportedProfile": [
            "http://hl7.org/fhir/us/mdi/StructureDefinition/Bundle-document-mdi-and-edrs"
          ],
          "interaction": [
            {
              "code": "read"
            }
          ]
        }
      ]
    }
  ],
  "messaging": [
    {
      "supportedMessage": [
        {
          "mode": "receiver",
          "definition": "http://hl7.org/fhir/us/mdi/MessageDefinition/MessageDefinition-toxicology-system"
        }
      ]
    }
  ],
  "document": [
    {
      "mode": "producer",
      "profile": "http://hl7.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
    },
    {
      "mode": "consumer",
      "profile": "http://hl7.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
    }
  ]
}