careMESH NPD
0.1.0 - ci-build United States of America flag

careMESH NPD - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: System level export for related sets of resources

Official URL: http://fhir.caremesh.app/OperationDefinition/caremesh-system-everything Version: 0.1.0
Active as of 2023-02-06 Computable Name: careMESH System Level Everything

FHIR Operation to return all resources related to either a type 1 (individual) or type 2 (organization) NPI, from the system level.

Generated Narrative: OperationDefinition caremesh-system-everything

URL: [base]/$everything

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INtype1-npi0..1string

A type 1 NPI to process. May be used in combination with the type2-npi parameter to get all common resources between the designated Practitioner and the designated Organization.

INtype2-npi0..1string

A type 2 NPI to process. May be used in combination with the type2-npi parameter to get all common resources between the designated Practitioner and the designated Organization.

IN_summary0..1boolean

The default response to the $everything system level call is a FHIR bundle containing all the necessary resources returned.

If _summary is specified and set to npiDump a Bundle will be returned as the following:

  {
    // a list of locations for the requested type 1 NPI in an
    // abbreviated format.  Will be omitted for type 2.
    "_practiceLocations": [{...}],
    // a list of known hospital affiliations for the requested type 1 
    // NPI (will be omitted for type 2)
    "_hospitalAffiliations": [{...}],
    // a list of organizations associated with the specified type 1 
    // or type 2 NPI
    "_organizations": [{...}],
    // a list of practitioners  associated with the specified type 1 
    // or type 2 NPI
    "_practitioners": [{...}],
    // a list of places where the organization associated with the type 2
    // npi offers services, irrespective of whether any requested 
    // practitioner offers services at those locations.
    "_organizationServiceLocations": [{...}],

  }
IN_type0..1string

A comma separated list of FHIR resource types to include in the result. If not included, defaults to all resource types available.