Jump to

• Request
• Response

Get a device by ID

get

/Device/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual device by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Device

Type: object

The FHIR R4 Device resource.

Show Source

• _distinctIdentifier: object PrimitiveElement
• _expirationDate: object PrimitiveElement
• _lotNumber: object PrimitiveElement
• _manufactureDate: object PrimitiveElement
• _serialNumber: object PrimitiveElement
• distinctIdentifier: string
• expirationDate: string (date-time)
• id(required): string
• lotNumber: string
• manufactureDate: string (date-time)
• patient(required): object ReferenceForDevice
• resourceType(required): string
  Allowed Values: [ "Device" ]
• serialNumber: string
• status(required): string
  Allowed Values: [ "active", "inactive", "entered-in-error", "unknown" ]
• type(required): object CodeableConcept
• udiCarrier(required): array udiCarrier

{
    "type":"object",
    "description":"The FHIR R4 Device resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Device"
            ]
        },
        "id":{
            "type":"string"
        },
        "udiCarrier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UdiCarrierForDevice"
            }
        },
        "distinctIdentifier":{
            "type":"string"
        },
        "_distinctIdentifier":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "manufactureDate":{
            "type":"string",
            "format":"date-time"
        },
        "_manufactureDate":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "expirationDate":{
            "type":"string",
            "format":"date-time"
        },
        "_expirationDate":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "lotNumber":{
            "type":"string"
        },
        "_lotNumber":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "serialNumber":{
            "type":"string"
        },
        "_serialNumber":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForDevice"
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive",
                "entered-in-error",
                "unknown"
            ]
        }
    },
    "required":[
        "resourceType",
        "id",
        "udiCarrier",
        "type",
        "patient",
        "status"
    ]
}

Nested Schema : PrimitiveElement

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : ReferenceForDevice

Type: object

Show Source

• reference: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : udiCarrier

Type: array

Show Source

• Array of: object UdiCarrierForDevice

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UdiCarrierForDevice"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : UdiCarrierForDevice

Type: object

Show Source

• _carrierHRF: object PrimitiveElement
• _deviceIdentifier: object PrimitiveElement
• carrierHRF: string
• deviceIdentifier: string

{
    "type":"object",
    "properties":{
        "deviceIdentifier":{
            "type":"string"
        },
        "_deviceIdentifier":{
            "$ref":"#/components/schemas/PrimitiveElement"
        },
        "carrierHRF":{
            "type":"string"
        },
        "_carrierHRF":{
            "$ref":"#/components/schemas/PrimitiveElement"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top