This List 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.
This resource represents a named List of resources that are supported by the API Server. It is used to access various resources that describe the configuration of the system.
This profile is used to list system configuration resources used by the API Server.
The List resource describes other resource instances found in the API Server. The API Server defines five lists:
| List | Description |
|---|---|
| All | A list of all vocabulary resources that are available. |
| ConceptMap | This list provides the identifiers of all ConceptMap resources supported by the API Server. These maps are used to support translation between different vocabularies, including translation between CPS and EMR terms stored in the product databases to codes used by the FHIR resources the API Server implements. See documentation on the ConceptMap resource for more information on how the resources in this list can be used and the operations it supports. |
| Flowsheet | A flowsheet is a specialization of the ValueSet resource that can be created by users of the CPS and EMR products. It is a named enumeration of CPS or EMR Observation terms used to organize observations for display, selection or query. See documentation on the ValueSet resource for more information on how the resources in this list can be used and the operations it supports. |
| NamingSystem | A list of all identifier systems that are known to the API Server. See documentation on the NamingSystem resource for more information on how the resources in this list can be used and the operations it supports. |
| ValueSet | A list of all ValueSet resources supported by the API Server. See documentation on the ValueSet resource for more information on how the resources in this list can be used and the operations it supports. |
The operations supported by this resource are listed below.
Read operations are executed as specified in the HL7 FHIR read operation definition. To read a List, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/List/[id]{?_format=[json|xml]&_summary=[true|data]}
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the List resource to retrieve. Supported values include All, Flowsheet, ValueSet, ConceptMap and NamingSystem |
| [_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. |
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 404 Not Found | The 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 Error | The 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. |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/ge-list-profile
The API Server supports the following fields of the List resource: