Supported Formats

json

GET /Device
Implantable devices bundle

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Device?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "c8e21c487f2b07f239d5c61cdd9a54e4",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Device/",
      "resource": {
        "resourceType": "Device",
        "status": "active",
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "704708004",
              "display": "Cardiac resynchronization therapy implantable pacemaker"
            }
          ]
        },
        "distinctIdentifier": "(01)00643169007222(17)160128(21)BLC200461H",
        "lotNumber": "unknown",
        "manufactureDate": "2011-10-05",
        "expirationDate": {
          "valueQuantity": {
            "extension": {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unknown"
            }
          },
          "dataAbsentReason": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                "code": "unknown",
                "display": "Unknown"
              }
            ],
            "text": "Unknown"
          }
        },
        "serialNumber": "unknown",
        "udiCarrier": [
          {
            "deviceIdentifier": "00643169007222",
            "carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"
          }
        ],
        "patient": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        }
      }
    }
  ],
  "total": 1
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.

patient
optional

ID of the requested patient

Validations:

  • Must be number.

start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Bundle

Validations:

  • Must be String.

type
required

Validations:

  • Must be String.


GET /Device/:id
Implantable device by id

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Device/1001?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Device",
  "id": "1001",
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "704708004",
        "display": "Cardiac resynchronization therapy implantable pacemaker"
      }
    ]
  },
  "distinctIdentifier": "(01)00643169007222(17)160128(21)BLC200461H",
  "lotNumber": "unknown",
  "manufactureDate": "2011-10-05",
  "expirationDate": "2016-10-05",
  "serialNumber": "unknown",
  "udiCarrier": [
    {
      "deviceIdentifier": "00643169007222",
      "carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"
    }
  ],
  "patient": {
    "reference": "Patient/1",
    "display": "Newman, Alice, Jones, Alicia, "
  }
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.

id
optional

ID of requested implantable device

Validations:

  • Must be number.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Device

Validations:

  • Must be String.

status
required

Validations:

  • Must be String.

type
required

Validations:

  • Must be Hash.

distinctIdentifier
required

Validations:

  • Must be String.

lotNumber
required

Validations:

  • Must be String.

manufactureDate
required

Validations:

  • Must be String.

expirationDate
required

Validations:

  • Must be String.

serialNumber
required

Validations:

  • Must be String.

udi_carrier
required

Validations:

  • Must be Array.

patient
required

Validations:

  • Must be Hash.


GET /Device/_search
Implantable device _search