Jump to

• Request
• Response

Retrieve Patient Groups for a patient

get

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

This endpoint returns the patient groups associated with a patient (row id)

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Minimum Value: 0

  Patient Row ID

Query Parameters

• code(optional): string
  Clinical Filter query params: ?code=DCode&name=DName
• dateType(optional): string
  Clinical Filter query params: ?code=DCode&name=DName
• endDate(optional): string
  Clinical Filter query params: ?code=DCode&name=DName
• name(optional): string
  Clinical Filter query params: ?code=DCode&name=DName
• startDate(optional): string
  Clinical Filter query params: ?code=DCode&name=DName

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 PatientGroup
  Model for PatientGroup object in CDM.

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

Nested Schema : PatientGroup

Type: object

Model for PatientGroup object in CDM.

Show Source

• groupDesc(optional): string
  Group Desc
• groupEndDate(optional): string(date-time)
  Group End date
• groupIdentifier(optional): string
  Group Identifier
• groupName(optional): string
  Group Name
• groupStartDate(optional): string(date-time)
  Group Start Date
• groupTypeCoding(optional): object Coding
  Model for a reference to a code defined by a terminology system.
• identifier(optional): object Identifier
  Identifier assigned by a given system
• participationEndDate(optional): string(date-time)
  Participation End Date
• participationStartDate(optional): string(date-time)
  Participation Start Date
• patientWid(optional): string
  patient Row Id
• responsiblePartyName(optional): string
  Responsible Party Name
• responsiblePartyNumber(optional): string
  Responsible Party Number

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Identifier information for this record.",
            "$ref":"#/definitions/Identifier"
        },
        "groupIdentifier":{
            "type":"string",
            "description":"Group Identifier"
        },
        "groupName":{
            "type":"string",
            "description":"Group Name"
        },
        "groupDesc":{
            "type":"string",
            "description":"Group Desc"
        },
        "groupStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"Group Start Date"
        },
        "groupEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"Group End date"
        },
        "participationStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"Participation Start Date"
        },
        "participationEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"Participation End Date"
        },
        "groupTypeCoding":{
            "description":"Codeable Concept for Group Type",
            "$ref":"#/definitions/Coding"
        },
        "responsiblePartyNumber":{
            "type":"string",
            "description":"Responsible Party Number"
        },
        "responsiblePartyName":{
            "type":"string",
            "description":"Responsible Party Name"
        },
        "patientWid":{
            "type":"string",
            "description":"patient Row Id"
        }
    },
    "description":"Model for PatientGroup object in CDM."
}

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"
}

400 Response

Invalid parameters supplied

404 Response

Patient group not found

Back to Top