Jump to

• Request
• Response

Get Patient Id demographics information

get

/ohfapi/cg/v3.3/patientapi/patients/identifier/basicinfo

This end point returns demographics information like Id,PatientIdentifier,Age,State and Gender values for the Patient Id(s) provided.If the operator is null, then it defaults to equals. If limit is null then defaults to 100.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer(int32)
  Limit
• operator(optional): string
  Patient Ids Search Operator

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• patientId(optional): array
  Collection Format: multi

  Patient Ids

  • [0]: string

  {
      "name":"patientId",
      "in":"query",
      "description":"Patient Ids",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatientBasicInfo
  Model for a Basic Patient Info

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatientBasicInfo"
    }
}

Nested Schema : PatientBasicInfo

Type: object

Model for a Basic Patient Info

Show Source

• age(optional): string
  Age of the patient
• gender(optional): string
  Gender Name of the patient
• id(optional): integer(int64)
  Patient Id
• patientIdentifier(optional): string
  Patient Identifier
• state(optional): string
  Patient's State

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Patient Id"
        },
        "patientIdentifier":{
            "type":"string",
            "description":"Patient Identifier"
        },
        "gender":{
            "type":"string",
            "description":"Gender Name of the patient"
        },
        "age":{
            "type":"string",
            "description":"Age of the patient"
        },
        "state":{
            "type":"string",
            "description":"Patient's State"
        }
    },
    "description":"Model for a Basic Patient Info"
}

400 Response

Invalid parameters supplied

404 Response

No data found

Back to Top