Virence Location Profile

This Location profile is part of the set of resource profiles supported by the API Server used with the CPS 12.3 and CEMR 9.12 products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource includes the physical location where health-related services are provided or otherwise accessed.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Location resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Location resource includes locations for healthcare facilities and other organizations supported by the CPS and CEMR products. It derives from the LOCREG and DoctorFacility tables in CPS, and the LOCREG table in CEMR. Specific detail can be found in the Mappings section below.

Supported Operations

The operations supported by this resource are listed below.

Read Operation

Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Location, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.

GET [base]/fhir/Location/[id]{?_format=[json|xml]&_summary=[true|data]}

Read Operation Parameters

ParameterDescription
[base]Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[id]Specifies the identifier of the Location resource to retrieve
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary]Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times.

Read Operation HTTP Response Codes

Response CodeDescription
200 OKThe requested resource was found and is contained within the body of the HTTP response.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
404 Not FoundThe requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Search Operation

Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Location resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/Location?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Search Operation Parameters

ParameterDescription
[base]Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_count]Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Location resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Virence Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary]Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token )The ID of the resource
_lastUpdated (date )
_lastUpdated-fromnow (quantity )Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
address-city (string )A city specified in an address
address-country (string )A country specified in an address
address-postalcode (string )A postal code specified in an address
address-state (string )A state specified in an address
identifier (token )Unique code or number identifying the location to its users
name (string )A (portion of the) name of the location
organization (reference )Searches for locations that are managed by the provided organization
partof (reference )The location of which this location is a part
status (token )Searches for locations with a specific kind of status

Search Operation HTTP Response Codes

Response CodeDescription
200 OKThe query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Profile Content

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/location-profile

Details and position information for a physical place

Name Flags Card. Type Description & Constraints
.. Location0..*Location Details and position information for a physical place
... meta0..1Meta Metadata about the resource
... implicitRules?! 0..1uri A set of rules under which this content was created
... language0..1code Language of the resource content

Binding: IETF BCP-47 (required )
... textI0..1Narrative Text summary of the resource, for human interpretation
... contained0..*Resource Contained, inline Resources
... extension0..*Extension Additional Content defined by implementations
... modifierExtension?!0..*Extension Extensions that cannot be ignored
... identifierS 0..*Identifier External ids for this item
... status?! 0..1code active | suspended | inactive

Binding: LocationStatus (required )
... name0..1string Name of the location as used by humans
... description0..1string Description of the location
... mode?! 0..1code instance | kind

Binding: LocationMode (required )
... type0..1CodeableConcept Type of function performed

Binding: ServiceDeliveryLocationRoleType (extensible )
... telecomContactPoint Contact details of the location

Slice: Unordered, Closed, by type use
... telecom0..4ContactPoint Contact details of the location
... telecom0..1ContactPoint Contact details of the location
.... extension0..*Extension Additional Content defined by implementations
.... systemI1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: phone
.... value1..1string The actual contact point details
.... use?! 0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )

Fixed Value: work
.... rank0..1positiveInt Specify preferred order of use (1 = highest)
.... period0..1Period Time period when the contact point was/is in use
... telecom0..1ContactPoint Contact details of the location
.... extension0..*Extension Additional Content defined by implementations
.... systemI1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: phone
.... value1..1string The actual contact point details
.... use?! 0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )
.... rank0..1positiveInt Specify preferred order of use (1 = highest)
.... period0..1Period Time period when the contact point was/is in use
... telecom0..1ContactPoint Contact details of the location
.... extension0..*Extension Additional Content defined by implementations
.... systemI1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: fax
.... value1..1string The actual contact point details
.... use?! 0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )
.... rank0..1positiveInt Specify preferred order of use (1 = highest)
.... period0..1Period Time period when the contact point was/is in use
... telecom0..1ContactPoint Contact details of the location
.... extension0..*Extension Additional Content defined by implementations
.... systemI1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: email
.... value1..1string The actual contact point details
.... use?! 0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )
.... rank0..1positiveInt Specify preferred order of use (1 = highest)
.... period0..1Period Time period when the contact point was/is in use
... address0..1Address Physical location
.... extension0..*Extension Additional Content defined by implementations
.... use?! 0..1code home | work | temp | old - purpose of this address

Binding: AddressUse (required )

Example: home
.... type0..1code postal | physical | both

Binding: AddressType (required )

Example: both
.... text0..1string Text representation of the address

Example: 137 Nowhere Street, Erewhon 9132
.... linestring Street name, number, direction & P.O. Box etc.

Slice: Ordered, Closed, by line

Example: 137 Nowhere Street
.... line0..2string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... line0..1string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... line0..1string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... city0..1string Name of city, town etc.

Example: Erewhon
.... district0..1string District name (aka county)

Example: Madison
.... state0..1string Sub-unit of country (abbreviations ok)
.... postalCode0..1string Postal code for area

Example: 9132
.... country0..1string Country (can be ISO 3166 3 letter code)
.... period0..1Period Time period when address was/is in use

Example: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType0..1CodeableConcept Physical form of the location

Binding: LocationType (example )
... position0..1BackboneElement The absolute geographic location
.... extension0..*Extension Additional Content defined by implementations
.... modifierExtension?!0..*Extension Extensions that cannot be ignored
.... longitude1..1decimal Longitude with WGS84 datum
.... latitude1..1decimal Latitude with WGS84 datum
.... altitude0..1decimal Altitude with WGS84 datum
... managingOrganization0..1Reference (Organization )Organization responsible for provisioning and upkeep
... partOf0..1Reference (Location )Another Location this one is physically part of


 

CPS Mapping

The mappings in this section represent the how data stored within CPS is served through the product's APIs. CPS and CEMR share a common schema for patient clinical data and only one is shown when these are the same. Use of this information is subject to the API Server Terms and Conditions .

Virence Location Profile
LocationLocation-ProfileFHIR_LOCATIONVIEW
 ├ idLOCIDMakeIdWithPrefix(%LOCID%,%ID_PREFIX%)
 ├ identifierExternal Location IdentifierMakeIdentifier("U",getSiteSystem("LocationId"),%LOCID%,%ID_PREFIX%)
 ├ statusMapCode(%STATUS%,"LOCSTATUS")
 ├ name%NAME%
 ├ description%DESCRIPTION%
 ├ telecomPhone Numbers
 ├ telecomWORKPHONE
  │ └ value%PRIMPHONE%
 ├ telecomALTPHONE
  │ └ value%SECPHONE%
 ├ telecomFAXPHONE
  │ └ value%FAXPHONE%
 ├ telecomEMAIL
  │ ├ value%EMAIL%
  │ ├ lineAddress Lines
  │ ├ lineADDRESS1%ADDRESS1%
  │ ├ lineADDRESS2%ADDRESS2%
  │ ├ city%CITY%
  │ ├ state%STATE%
  │ ├ postalCode%ZIP%
  │ └ country%COUNTRY%
 ├ managingOrganizationMakeReference("LOCREG",%FACILITYID%,"Organization")
 └ partOfMakeReference("LOCREG",%PARENTID%,"Location")

CEMR Mapping

The mappings in this section represent the how data stored within CEMR is served through the product's APIs. Use of this information is subject to the API Server Terms and Conditions .

Virence Location Profile
LocationLocation-ProfileFHIR_LOCATIONVIEW
 ├ idLOCIDMakeId(%LOCID%)
 ├ identifierExternal Location IdentifierMakeIdentifier("U",getSiteSystem("LocationId"),%LOCID%)
 ├ statusMapCode(%STATUS%,"LOCSTATUS")
 ├ name%NAME%
 ├ description%DESCRIPTION%
 ├ telecomPhone Numbers
 ├ telecomWORKPHONE
  │ └ value%PRIMPHONE%
 ├ telecomALTPHONE
  │ └ value%SECPHONE%
 ├ telecomFAXPHONE
  │ └ value%FAXPHONE%
 ├ telecomEMAIL
  │ ├ value%EMAIL%
  │ ├ lineAddress Lines
  │ ├ lineADDRESS1%ADDRESS1%
  │ ├ lineADDRESS2%ADDRESS2%
  │ ├ city%CITY%
  │ ├ state%STATE%
  │ ├ postalCode%ZIP%
  │ └ country%COUNTRY%
 ├ managingOrganizationMakeReference("LOCREG",%ORGANIZATIONID%,"Organization")
 └ partOfMakeReference("LOCREG",%PARENTID%,"Location")