{ "opencollection": "1.0.0", "info": { "name": "Untitled CodeSystem Location API", "version": "unspecified" }, "items": [ { "info": { "name": "Location", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Location instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "read-instance: Read Location instance" }, { "info": { "name": "update-instance: Update an existing Location instance, or create using a client-assigned ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "update-instance: Update an existing Location instance, or create using a client-assigned ID" }, { "info": { "name": "instance-patch: Patch a resource instance of type Location by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "instance-patch: Patch a resource instance of type Location by ID" }, { "info": { "name": "instance-delete: Perform a logical delete on a resource instance", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "instance-delete: Perform a logical delete on a resource instance" }, { "info": { "name": "vread-instance: Read Location instance with specific version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/:id/_history/:version_id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "version_id", "value": "1", "type": "path", "description": "The resource version ID" } ] }, "docs": "vread-instance: Read Location instance with specific version" }, { "info": { "name": "search-type: Search for Location instances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location", "params": [ { "name": "address-state", "value": "", "type": "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
" }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "When the resource version last changed" }, { "name": "operational-status", "value": "", "type": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)" }, { "name": "type", "value": "", "type": "query", "description": "A code for the type of location" }, { "name": "address-country", "value": "", "type": "query", "description": "A country specified in an address" }, { "name": "endpoint", "value": "", "type": "query", "description": "Technical endpoints providing access to services operated for the location" }, { "name": "near", "value": "", "type": "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).\nIf 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)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also" }, { "name": "address-city", "value": "", "type": "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
" }, { "name": "identifier", "value": "", "type": "query", "description": "An identifier for the location" }, { "name": "partof", "value": "", "type": "query", "description": "A location of which this location is a part" }, { "name": "address", "value": "", "type": "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
" }, { "name": "_security", "value": "", "type": "query", "description": "Security Labels applied to this resource" }, { "name": "address-postalcode", "value": "", "type": "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
" }, { "name": "_filter", "value": "", "type": "query", "description": "Search the contents of the resource's data using a filter" }, { "name": "_profile", "value": "", "type": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_tag", "value": "", "type": "query", "description": "Tags applied to this resource" }, { "name": "organization", "value": "", "type": "query", "description": "Searches for locations that are managed by the provided organization" }, { "name": "_has", "value": "", "type": "query", "description": "Return resources linked to by the given target" }, { "name": "address-use", "value": "", "type": "query", "description": "A use code specified in an address" }, { "name": "name", "value": "", "type": "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
" }, { "name": "_source", "value": "", "type": "query", "description": "Identifies where the resource comes from" }, { "name": "_id", "value": "", "type": "query", "description": "Logical id of this artifact" }, { "name": "_text", "value": "", "type": "query", "description": "Search on the narrative of the resource" }, { "name": "_content", "value": "", "type": "query", "description": "Search on the entire content of the resource" }, { "name": "status", "value": "", "type": "query", "description": "Searches for locations with a specific kind of status" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Location instance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location", "body": { "type": "json", "data": "{}" } }, "docs": "create-type: Create a new Location instance" }, { "info": { "name": "type-history: Fetch the resource change history for all resources of type Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/_history" }, "docs": "type-history: Fetch the resource change history for all resources of type Location" }, { "info": { "name": "instance-history: Fetch the resource change history for all resources of type Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/:id/_history", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "instance-history: Fetch the resource change history for all resources of type Location" }, { "info": { "name": "search-type: Search for Location instances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/_search", "params": [ { "name": "address-state", "value": "", "type": "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
" }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "When the resource version last changed" }, { "name": "operational-status", "value": "", "type": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)" }, { "name": "type", "value": "", "type": "query", "description": "A code for the type of location" }, { "name": "address-country", "value": "", "type": "query", "description": "A country specified in an address" }, { "name": "endpoint", "value": "", "type": "query", "description": "Technical endpoints providing access to services operated for the location" }, { "name": "near", "value": "", "type": "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).\nIf 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)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also" }, { "name": "address-city", "value": "", "type": "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
" }, { "name": "identifier", "value": "", "type": "query", "description": "An identifier for the location" }, { "name": "partof", "value": "", "type": "query", "description": "A location of which this location is a part" }, { "name": "address", "value": "", "type": "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
" }, { "name": "_security", "value": "", "type": "query", "description": "Security Labels applied to this resource" }, { "name": "address-postalcode", "value": "", "type": "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
" }, { "name": "_filter", "value": "", "type": "query", "description": "Search the contents of the resource's data using a filter" }, { "name": "_profile", "value": "", "type": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_tag", "value": "", "type": "query", "description": "Tags applied to this resource" }, { "name": "organization", "value": "", "type": "query", "description": "Searches for locations that are managed by the provided organization" }, { "name": "_has", "value": "", "type": "query", "description": "Return resources linked to by the given target" }, { "name": "address-use", "value": "", "type": "query", "description": "A use code specified in an address" }, { "name": "name", "value": "", "type": "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
" }, { "name": "_source", "value": "", "type": "query", "description": "Identifies where the resource comes from" }, { "name": "_id", "value": "", "type": "query", "description": "Logical id of this artifact" }, { "name": "_text", "value": "", "type": "query", "description": "Search on the narrative of the resource" }, { "name": "_content", "value": "", "type": "query", "description": "Search on the entire content of the resource" }, { "name": "status", "value": "", "type": "query", "description": "Searches for locations with a specific kind of status" } ] }, "docs": "This is a search type" }, { "info": { "name": "GET /Location/$validate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/$validate", "params": [ { "name": "mode", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /Location/$validate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/$validate", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Location/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/:id/$validate", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "mode", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /Location/{id}/$validate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/:id/$validate", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Location/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/:id/$meta-delete", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete tags, profiles, and/or security labels from a resource" }, { "info": { "name": "POST /Location/{id}/$meta-add", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/:id/$meta-add", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add tags, profiles, and/or security labels to a resource" }, { "info": { "name": "GET /Location/$meta", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/$meta" }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Location/$meta", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/$meta", "body": { "type": "json", "data": "{}" } }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "GET /Location/{id}/$meta", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Location/:id/$meta", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Location/{id}/$meta", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/:id/$meta", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Location/$expunge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Location/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Location/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } } ] } ], "bundled": true }