FHIR IG Statistics: CapabilityStatement/HumanServicesDirectory

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

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

Source

{
  "resourceType": "CapabilityStatement",
  "id": "HumanServicesDirectory",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "hss"
    }
  ],
  "url": "http://hl7.org/fhir/us/hsds/CapabilityStatement/HumanServicesDirectory",
  "version": "1.0.0",
  "name": "HumanServicesDirectoryCapabilityStatement",
  "title": "Human Services Directory Capability Statement",
  "status": "draft",
  "experimental": false,
  "date": "2023-08-05",
  "publisher": "HL7 Human and Social Services Work Group",
  "contact": [
    {
      "name": "HL7 Human and Social Services Work Group",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/hsswg/index.cfm"
        },
        {
          "system": "email",
          "value": "hsswg@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Describes the expected capabilities of the Human Services Directory Server actor responsible for providing responses to the queries submitted by the Human Services Directory Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Human Services Directory (HSD) Servers are defined.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/hsds/ImplementationGuide/hl7.fhir.us.hsds"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Location",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location",
          "documentation": "Read a location (details and position information) for a physical place where human and social services are provided.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "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": "name",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-name",
              "type": "string",
              "documentation": "Search for locations by a portion of the location's name or alias."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.country",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-country",
              "type": "string",
              "documentation": "Search for locations by a country specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "hoursofoperation",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-hoursofoperation",
              "type": "string",
              "documentation": "Search for locations by hours of operation."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "accessibility",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-accessibility",
              "type": "token",
              "documentation": "Search for locations by accessibiity options."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address",
              "type": "string",
              "documentation": "Search for locations by a (part of the) address of the location."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-city",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-city",
              "type": "string",
              "documentation": "Search for locations by city specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-state",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-state",
              "type": "string",
              "documentation": "Search for locations by state specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address-postalcode",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-address-postalcode",
              "type": "string",
              "documentation": "Search for locations by postal code specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "organization",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/location-organization",
              "type": "reference",
              "documentation": "Search for locations that are managed by the specified organization."
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization",
          "documentation": "Read a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "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/hsds/SearchParameter/organization-address",
              "type": "string",
              "documentation": "Search for organizations specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.postalCode",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-postalcode",
              "type": "string",
              "documentation": "Search for organizations by postal code specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.state",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-state",
              "type": "string",
              "documentation": "Search for organizations by state specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address.city",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-address-city",
              "type": "string",
              "documentation": "Search for organizations by city specified in an address."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-identifier",
              "type": "token",
              "documentation": "Search for organizations by tax identifier (business indentifier) associated with human services organizations."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-name",
              "type": "string",
              "documentation": "Search for organizations by a portion of the organization's name or alias."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/organization-type",
              "type": "token",
              "documentation": "Search for organizations by (a code for) the type of organization."
            }
          ]
        },
        {
          "type": "HealthcareService",
          "profile": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService",
          "documentation": "Read the details of human and social services resources that are available at a location.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "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": "communication",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-communication",
              "type": "string",
              "documentation": "Search for human and social services by the language in which services are delivered."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "program",
              "definition": "http://hl7.org/fhir/us/hsds/SearchParameter/healthcareservice-program",
              "type": "token",
              "documentation": "Search for human and social services by the program under which this service is delivered."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-category",
              "type": "token",
              "documentation": "Search for human and social services by the specified category of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type",
              "type": "token",
              "documentation": "Search for human and social services by the specified type of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "type": "token",
              "documentation": "Search for human and social services by the specified status of service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "type": "string",
              "documentation": "Search for human and social services by the specified status for the service."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "location",
              "type": "reference",
              "documentation": "Search for human and social services offered at the specified location."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "organization",
              "type": "reference",
              "documentation": "Search for human and social services offered by the specified organization."
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ]
    }
  ]
}