swagger: '2.0' info: description: "Fast Healthcare Interoperability Resources (FHIR, pronounced \"Fire\") defines a set of \"Resources\" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation. \n" title: Untitled CodeSystem Location API version: unspecified host: api.prod.devoted.com basePath: /fhir/ schemes: - https tags: - name: Location description: The Location FHIR resource type paths: /Location/{id}: get: tags: - Location summary: 'read-instance: Read Location instance' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null put: tags: - Location summary: 'update-instance: Update an existing Location instance, or create using a client-assigned ID' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"Location\"\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null delete: tags: - Location summary: 'instance-delete: Perform a logical delete on a resource instance' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null patch: tags: - Location summary: 'instance-patch: Patch a resource instance of type Location by ID' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/_history/{version_id}: get: tags: - Location summary: 'vread-instance: Read Location instance with specific version' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' - name: version_id in: path description: The resource version ID required: true style: simple schema: minimum: 1 type: string example: null example: '1' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location: get: tags: - Location summary: 'search-type: Search for Location instances' description: This is a search type parameters: - name: address-state in: query description: "A state specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: operational-status in: query description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) style: simple - name: type in: query description: A code for the type of location style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the location style: simple - name: near in: query description: 'Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also' style: simple - name: address-city in: query description: "A city specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: "A (part of the) address of the location
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: "A postal code specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Searches for locations that are managed by the provided organization style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: "A portion of the location's name or alias
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Searches for locations with a specific kind of status style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location summary: 'create-type: Create a new Location instance' requestBody: content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: "{\n \"resourceType\": \"Location\"\n}" application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/_history: get: tags: - Location summary: 'type-history: Fetch the resource change history for all resources of type Location' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/_history: get: tags: - Location summary: 'instance-history: Fetch the resource change history for all resources of type Location' parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/_search: get: tags: - Location summary: 'search-type: Search for Location instances' description: This is a search type parameters: - name: address-state in: query description: "A state specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _lastUpdated in: query description: When the resource version last changed style: simple - name: operational-status in: query description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) style: simple - name: type in: query description: A code for the type of location style: simple - name: address-country in: query description: A country specified in an address style: simple - name: endpoint in: query description: Technical endpoints providing access to services operated for the location style: simple - name: near in: query description: 'Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also' style: simple - name: address-city in: query description: "A city specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: identifier in: query description: An identifier for the location style: simple - name: partof in: query description: A location of which this location is a part style: simple - name: address in: query description: "A (part of the) address of the location
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _security in: query description: Security Labels applied to this resource style: simple - name: address-postalcode in: query description: "A postal code specified in an address
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _filter in: query description: Search the contents of the resource's data using a filter style: simple - name: _profile in: query description: Profiles this resource claims to conform to style: simple - name: _tag in: query description: Tags applied to this resource style: simple - name: organization in: query description: Searches for locations that are managed by the provided organization style: simple - name: _has in: query description: Return resources linked to by the given target style: simple - name: address-use in: query description: A use code specified in an address style: simple - name: name in: query description: "A portion of the location's name or alias
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" style: simple - name: _source in: query description: Identifies where the resource comes from style: simple - name: _id in: query description: Logical id of this artifact style: simple - name: _text in: query description: Search on the narrative of the resource style: simple - name: _content in: query description: Search on the entire content of the resource style: simple - name: status in: query description: Searches for locations with a specific kind of status style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$validate: get: tags: - Location parameters: - name: mode in: query required: false style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Location\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$validate: get: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' - name: mode in: query required: false style: simple responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Location\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta-delete: post: tags: - Location description: Delete tags, profiles, and/or security labels from a resource parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta-add: post: tags: - Location description: Add tags, profiles, and/or security labels to a resource parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$meta: get: tags: - Location description: Request a list of tags, profiles, and security labels for a specfic resource instance responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location description: Request a list of tags, profiles, and security labels for a specfic resource instance requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\"\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$meta: get: tags: - Location description: Request a list of tags, profiles, and security labels for a specfic resource instance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null post: tags: - Location description: Request a list of tags, profiles, and security labels for a specfic resource instance parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\"\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/$expunge: post: tags: - Location requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null /Location/{id}/$expunge: post: tags: - Location parameters: - name: id in: path description: The resource ID required: true style: simple schema: minimum: 1 type: string example: null example: '123' requestBody: content: application/fhir+json: schema: title: FHIR Resource type: object example: null example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" responses: '200': description: Success content: application/fhir+json: schema: $ref: '#/components/schemas/FHIR-JSON-RESOURCE' example: null application/fhir+xml: schema: $ref: '#/components/schemas/FHIR-XML-RESOURCE' example: null components: schemas: FHIR-JSON-RESOURCE: type: object description: A FHIR resource example: null FHIR-XML-RESOURCE: type: object description: A FHIR resource example: null