Medicolegal Death Investigation (MDI)
1.1.0 - STU 1.1 United States of America flag

This page is part of the Medicolegal Death Investigation (MDI) (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: CapabilityStatement - MDI CMS Server - JSON Representation

Active as of 2022-07-03

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "CapabilityStatement-mdi-cms-server",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <h2 id=\"test1\" class=\"no_toc\">MDI CMS Server Capabilities Summary</h2>\n            <ul>\n                <li>The MDI CMS Server should be a producer of Composition-mdi-and-edrs, and may\n                    also be a consumer of Composition-mdi-and-edrs.</li>\n                <li>The MDI CMS Server may specify RESTful operations for resources. At a minimum,\n                    it should support read and search for the set of resources defined here.</li>\n                <li>The MDI CMS Server may support messaging with forensic toxicology, for\n                    example.</li>\n            </ul>\n            <h2 id=\"test1\" class=\"no_toc\">API Specifications Search Operations</h2>\n            <p>The MDI CMS Server may use extended operations with MDI-specific search parameters\n                and a subset of the many [RESTful API](https://hl7.org/FHIR/http.html).</p>\n            <p>All API implementations of this MDI FHIR IG must conform to common design\n                rules:</p>\n            <ul>\n                <li>MIME-type for FHIR resources is application/fhir+xml or application/fhir+json.\n                    This must be specified for Content-Type in the HTTP header. </li>\n                <li>application/x-www-form-urlencoded can be used for POST search requests if HTTP\n                    Form is used. </li>\n            </ul>\n            <p>An MDI-based Search API enables an MDI CMS to search an EDRS for decedent cases, and\n                vice versa. This is an idempotent operation. At a minimum, both Both POST and GET\n                can be used should be allowed with the following endpoint URL pattern:</p>\n            <ul>\n                <li>POST [base]/Composition/$document </li>\n                <li>GET [base]/Composition/$document?name=value… </li>\n            </ul>\n            <p id=\"summary\">\n                <strong>Summary of Minimum MDI Search Parameter Definitions</strong>\n            </p>\n            <table class=\"grid\">\n                <thead>\n                    <tr>\n                        <th>Search Parameter Name</th>\n                        <th>Cardinality</th>\n                        <th>Type</th>\n                        <th>Description</th>\n                    </tr>\n                </thead>\n                <tbody>\n                    <tr>\n                        <td><b><i>In Parameters</i></b></td>\n                        <td>  </td>\n                        <td>  </td>\n                        <td>  </td>\n                    </tr>\n                    <tr>\n                        <td>id</td>\n                        <td>0..1</td>\n                        <td>uri</td>\n                        <td>Composition.id of Composition - MDI and EDRS</td>\n                    </tr>\n                    <tr>\n                        <td>tracking-number</td>\n                        <td>0..*</td>\n                        <td>token</td>\n                        <td>Composition.extension:extension-tracking-number of Composition - MDI and\n                            EDRS</td>\n                    </tr>\n                    <tr>\n                        <td>patient</td>\n                        <td>0..*</td>\n                        <td/>\n                        <td>One or more US Core Patient decedent-related search parameters</td>\n                    </tr>\n                    <tr>\n                        <td>patient.birthdate</td>\n                        <td>0..1</td>\n                        <td>date</td>\n                        <td>Decedent’s date of birth</td>\n                    </tr>\n                    <tr>\n                        <td>patient.family</td>\n                        <td>0..1</td>\n                        <td>string</td>\n                        <td>Decedent’s last name</td>\n                    </tr>\n                    <tr>\n                        <td>patient.given</td>\n                        <td>0..1</td>\n                        <td>string</td>\n                        <td>Decedent’s first name</td>\n                    </tr>\n                    <tr>\n                        <td>patient.gender</td>\n                        <td>0..1</td>\n                        <td>token</td>\n                        <td>Decedent’s gender</td>\n                    </tr>\n                    <tr>\n                        <td>death-location</td>\n                        <td>0..1</td>\n                        <td>string</td>\n                        <td>Location.address in Location-death </td>\n                    </tr>\n                    <tr>\n                        <td>death-date</td>\n                        <td>0..1</td>\n                        <td>date</td>\n                        <td>Value[x] (actual or presumed date of death) in Observation - Death Date\n                            (either dateTime or Period)</td>\n                    </tr>\n                    <tr>\n                        <td>death-date-pronounced</td>\n                        <td>0..1</td>\n                        <td>date</td>\n                        <td>Observation.component:datetimePronouncedDead in Observation - Death Date\n                            (either time or dateTime)</td>\n                    </tr>\n                    <tr>\n                        <td><b><i>Out Parameters</i></b></td>\n                        <td>  </td>\n                        <td>  </td>\n                        <td>  </td>\n                    </tr>\n                    <tr>\n                        <td>return</td>\n                        <td>0..1</td>\n                        <td>Bundle</td>\n                        <td>Bundle - Searchset or Bundle - Document MDI and EDRS. If [id] is supplied, then this should be Bundle - Document MDI and EDRS</td>\n                    </tr>\n                </tbody>\n            </table>\n        </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pher"
    }
  ],
  "url" : "http://hl7.org/fhir/us/mdi/CapabilityStatement/CapabilityStatement-mdi-cms-server",
  "version" : "1.1.0",
  "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"
        }
      ],
      "text" : "United States of America"
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "xml",
    "application/fhir+json",
    "json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "resource" : [
        {
          "type" : "Composition",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
          ],
          "interaction" : [
            {
              "code" : "search-type"
            },
            {
              "code" : "read"
            }
          ],
          "searchParam" : [
            {
              "name" : "subject",
              "type" : "reference",
              "documentation" : "Who and/or what the composition is about"
            },
            {
              "name" : "patient",
              "type" : "reference",
              "documentation" : "Who and/or what the composition is about"
            }
          ],
          "operation" : [
            {
              "name" : "operation-composition-document",
              "definition" : "https://hl7.org/fhir/operation-composition-document",
              "documentation" : "A server should be capable of generating a bundled document from a composition resource with all the referenced resources and either returns a full document bundle, or returns an error."
            }
          ]
        },
        {
          "type" : "Patient",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ],
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "birthdate",
              "definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
              "type" : "date",
              "documentation" : "The patient's date of birth"
            },
            {
              "name" : "family",
              "type" : "string",
              "documentation" : "A portion of the family name of the patient"
            },
            {
              "name" : "given",
              "definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
              "type" : "string",
              "documentation" : "A portion of the given name of the patient"
            },
            {
              "name" : "gender",
              "definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
              "type" : "token",
              "documentation" : "Gender of the patient"
            },
            {
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
              "type" : "string",
              "documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
            }
          ]
        },
        {
          "type" : "Location",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/us/mdi/StructureDefinition/Location-death"
          ],
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "address",
              "type" : "string"
            }
          ]
        },
        {
          "type" : "Observation",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/us/mdi/StructureDefinition/Observation-death-date"
          ],
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "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" : "https://fhir.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
    },
    {
      "mode" : "consumer",
      "profile" : "https://fhir.org/fhir/us/mdi/StructureDefinition/Composition-mdi-and-edrs"
    }
  ]
}