Jump to

• Request
• Response

Retrieve Demographics for a Patient Identifier

get

/ohfapi/cg/v3.3/patientapi/patients/identifier/{id}

This endpoint supports the retrieval of Patient Demographics for a Patient Identifier. It returns Patient Demographic information like Name, Telecom, Marital Status, Gender, Deceased Date, Birth Date, Address and other Demographics associated information for the patient.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Patient Identifier

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : Patient

Type: object

Model for a Patient object in CDM.

Show Source

• address(optional): object Address
  Model for a postal address.
• ageInYears(optional): integer(int32)
  Age in Years
• birthDate(optional): string(date-time)
  Date of Birth
• deceasedBoolean(optional): boolean
  Alive or Deceased
• deceasedDate(optional): string(date-time)
  Deceased Date
• ethnicity(optional): object LinkedReference
• gender(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
• identifiers(optional): array identifiers
  A list of identifiers assigned to this patient
• lastContactDate(optional): string(date-time)
  Last Contact Date
• maritalStatus(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
• name(optional): object HumanName
  Model for a name of a human with text and parts information.
• race(optional): object LinkedReference
• subject(optional): object LinkedReference
• telecom(optional): object Telecom

{
    "type":"object",
    "properties":{
        "identifiers":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A list of identifiers assigned to this patient",
            "items":{
                "xml":{
                    "name":"identifier"
                },
                "$ref":"#/definitions/Identifier"
            }
        },
        "name":{
            "description":"Human Name",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"Telecom Details",
            "$ref":"#/definitions/Telecom"
        },
        "gender":{
            "description":"Gender Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "birthDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date of Birth"
        },
        "ageInYears":{
            "type":"integer",
            "format":"int32",
            "description":"Age in Years"
        },
        "deceasedBoolean":{
            "type":"boolean",
            "description":"Alive or Deceased"
        },
        "deceasedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Deceased Date"
        },
        "lastContactDate":{
            "type":"string",
            "format":"date-time",
            "description":"Last Contact Date"
        },
        "maritalStatus":{
            "description":"Marital Status",
            "$ref":"#/definitions/CodeableConcept"
        },
        "address":{
            "description":"Address Details",
            "$ref":"#/definitions/Address"
        },
        "race":{
            "$ref":"#/definitions/LinkedReference"
        },
        "ethnicity":{
            "$ref":"#/definitions/LinkedReference"
        },
        "subject":{
            "example":"{href: '/subjectapi/subjects/{subjectId}'}",
            "description":"A link containing href to retrieve Subject details",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for a Patient object in CDM."
}

Nested Schema : Address

Type: object

Model for a postal address.

Show Source

• city(optional): string
  Name of city, town etc.
• country(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
• district(optional): string
  District name (aka county).
• line(optional): array line
  Street name, number, direction & P.O. Box etc.
• postalCode(optional): string
  Postal code for area.
• state(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"Street name, number, direction & P.O. Box etc.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"Name of city, town etc."
        },
        "district":{
            "type":"string",
            "description":"District name (aka county)."
        },
        "state":{
            "description":"Sub-unit of country (abbreviations ok).",
            "$ref":"#/definitions/CodeableConcept"
        },
        "postalCode":{
            "type":"string",
            "description":"Postal code for area."
        },
        "country":{
            "description":"Country (can be ISO 3166 3 letter code).",
            "$ref":"#/definitions/CodeableConcept"
        }
    },
    "description":"Model for a postal address."
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

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

Nested Schema : CodeableConcept

Type: object

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Show Source

• coding(optional): array coding
  Read Only: true

  Code(s) defined by a terminology system.
• text(optional): string
  Plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"coding"
                },
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text."
}

Nested Schema : identifiers

Type: array

A list of identifiers assigned to this patient

Show Source

• Array of: object Identifier
  Identifier assigned by a given system

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A list of identifiers assigned to this patient",
    "items":{
        "xml":{
            "name":"identifier"
        },
        "$ref":"#/definitions/Identifier"
    }
}

Nested Schema : HumanName

Type: object

Model for a name of a human with text and parts information.

Show Source

• family(optional): string
  Family name (often called 'Surname').
• given(optional): array given
  Given names (not always 'first'). Includes middle names.
• text(optional): string
  Text representation of the full name.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Text representation of the full name."
        },
        "family":{
            "type":"string",
            "description":"Family name (often called 'Surname')."
        },
        "given":{
            "type":"array",
            "description":"Given names (not always 'first'). Includes middle names.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for a name of a human with text and parts information."
}

Nested Schema : Telecom

Type: object

Show Source

• use(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
• value(optional): string
  Telecom Value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Telecom Value"
        },
        "use":{
            "description":"Telecom Use CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : line

Type: array

Street name, number, direction & P.O. Box etc.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Street name, number, direction & P.O. Box etc.",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

Read Only: true

Code(s) defined by a terminology system.

Show Source

• Array of: object Coding
  Model for a reference to a code defined by a terminology system.

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"coding"
        },
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Type: object

Model for a reference to a code defined by a terminology system.

Show Source

• code(optional): string
  Symbol in syntax defined by the system.
• description(optional): string
  Description defined by the system.
• display(optional): string
  Representation defined by the system.
• srvcProviderId(optional): string
  Service Provider Id of Specimen Alias .
• srvcProviderName(optional): string
  Service Provider Name of Specimen Alias .
• sysId(optional): string
  Identity of the terminology system.
• sysName(optional): string
  Name of the terminology system.
• sysVersion(optional): string
  Version of the system - if relevant.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        },
        "srvcProviderId":{
            "type":"string",
            "description":"Service Provider Id of Specimen Alias ."
        },
        "srvcProviderName":{
            "type":"string",
            "description":"Service Provider Name of Specimen Alias ."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Show Source

• system(optional): string
  System which assigned this identifier
• value(optional): string
  Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : given

Type: array

Given names (not always 'first'). Includes middle names.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Given names (not always 'first'). Includes middle names.",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid parameters supplied

404 Response

Patient(s) not found

Back to Top