Jump to

• Request
• Response
• Examples

Retrieve Demographics for Cohort List Name or Subject Record id

get

/ohfapi/cg/v3.3/subjectapi/subjects

This endpoint supports the retrieval of Demographics for multiple Subject ids or Cohort List Name. It returns Subject information like Name, Telecom, Address and other Subject associated information.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• cohortListName(optional): string
  Cohort list name
• id(optional): array
  Collection Format: multi

  Subject Row ID(s) (cannot be passed while requesting for subjects by cohort list name)

  • [0]: integer(int64)

  {
      "name":"id",
      "in":"query",
      "description":"Subject Row ID(s) (cannot be passed while requesting for subjects by cohort list name)",
      "required":false,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi"
  }

• limit(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0
• offset(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollectionSubject

Type: object

Model for paginated collections of data.

Show Source

• count(optional): integer(int64)
  Number of objects in the 'items' collection.
• hasMore(optional): boolean
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  A collection of links containing hrefs to the current, next, and previous pages as applicable.
• resourceType(optional): string
  Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Subject"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Subject

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Subject"
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Nested Schema : Subject

Type: object

Show Source

• address(optional): object Address
  Model for a postal address.
• birthDate(optional): string(date-time)
  Date of Birth
• deceasedBoolean(optional): boolean
  Deceased or Not
• deceasedDate(optional): string(date-time)
  Deceased Date
• endDate(optional): string(date-time)
  Enrollment End Date
• enrollmentDate(optional): string(date-time)
  Enrollment 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
  Specimen Identifier
• 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.
• patient(optional): object LinkedReference
• patientIdentifier(optional): string
  Patient Identifier
• race(optional): object LinkedReference
• startDate(optional): string(date-time)
  Enrollment Start Date
• studyIdentifier(optional): string
  Study Identifier
• studyName(optional): string
  Study Name
• telecom(optional): object Telecom

{
    "type":"object",
    "properties":{
        "identifiers":{
            "type":"array",
            "description":"Specimen Identifier",
            "items":{
                "$ref":"#/definitions/Identifier"
            }
        },
        "studyName":{
            "type":"string",
            "description":"Study Name"
        },
        "studyIdentifier":{
            "type":"string",
            "description":"Study Identifier"
        },
        "patientIdentifier":{
            "type":"string",
            "description":"Patient Identifier"
        },
        "patient":{
            "$ref":"#/definitions/LinkedReference"
        },
        "name":{
            "description":"Human Name",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"Telecom Details",
            "$ref":"#/definitions/Telecom"
        },
        "gender":{
            "description":"Gender CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "birthDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date of Birth"
        },
        "deceasedBoolean":{
            "type":"boolean",
            "description":"Deceased or Not"
        },
        "deceasedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Deceased Date"
        },
        "maritalStatus":{
            "description":"Marital Status CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "address":{
            "description":"Address Details",
            "$ref":"#/definitions/Address"
        },
        "enrollmentDate":{
            "type":"string",
            "format":"date-time",
            "description":"Enrollment Date"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"Enrollment Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"Enrollment End Date"
        },
        "race":{
            "$ref":"#/definitions/LinkedReference"
        },
        "ethnicity":{
            "$ref":"#/definitions/LinkedReference"
        }
    }
}

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

Specimen Identifier

Show Source

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

{
    "type":"array",
    "description":"Specimen Identifier",
    "items":{
        "$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

Subject(s) not found

Back to Top

Examples

The following example submits a GET request.

Example 1 ??? API URL with Cohort List Name as Input

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects?cohortListName=Cohort_List_Test5

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "1"
        },
        {
          "system": "Customer Defined",
          "value": "S1_1"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P2_2",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients"
      },
      "name": {
        "text": "Juan MN1 Hernandez",
        "family": "Hernandez",
        "given": [
          "Juan",
          "MN1"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/01/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD11",
          "SADD21",
          "SADD31"
        ],
        "city": "C1",
        "district": "C1",
        "state": {
          "coding": [
            {
              "code": "1",
              "display": "State1",
              "description": "State1Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z1",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "2"
        },
        {
          "system": "Customer Defined",
          "value": "S2_2"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P3_3",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/patients"
      },
      "name": {
        "text": "John MN2 Jones",
        "family": "Jones",
        "given": [
          "John",
          "MN2"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/14/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD12",
          "SADD22",
          "SADD32"
        ],
        "city": "C2",
        "district": "C2",
        "state": {
          "coding": [
            {
              "code": "2",
              "display": "State2",
              "description": "State2Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z2",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "3"
        },
        {
          "system": "Customer Defined",
          "value": "S3_3"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P3_3",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/patients"
      },
      "name": {
        "text": "Hans MN3 Olsen",
        "family": "Olsen",
        "given": [
          "Hans",
          "MN3"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/27/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD13",
          "SADD23",
          "SADD33"
        ],
        "city": "C3",
        "district": "C3",
        "state": {
          "coding": [
            {
              "code": "0",
              "display": "State0",
              "description": "State0Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z3",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "4"
        },
        {
          "system": "Customer Defined",
          "value": "S4_4"
        }
      ],
      "studyName": "STUDY2",
      "studyIdentifier": "2",
      "patientIdentifier": "P4_4",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/patients"
      },
      "name": {
        "text": "Mary MN4 Johnson",
        "family": "Johnson",
        "given": [
          "Mary",
          "MN4"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "02/09/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD14",
          "SADD24",
          "SADD34"
        ],
        "city": "C4",
        "district": "C4",
        "state": {
          "coding": [
            {
              "code": "1",
              "display": "State1",
              "description": "State1Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z4",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/ethnicity"
      }
    }
  ],
  "count": 4,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects?cohortListName=Cohort_List_Test5"
    }
  ]
}

Example 1 ??? API URL with Subject IDs as Input

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects?id=1&id=2&id=3&id=4&id=5&limit=10&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "1"
        },
        {
          "system": "Customer Defined",
          "value": "S1_1"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P2_2",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients"
      },
      "name": {
        "text": "Juan MN1 Hernandez",
        "family": "Hernandez",
        "given": [
          "Juan",
          "MN1"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/01/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD11",
          "SADD21",
          "SADD31"
        ],
        "city": "C1",
        "district": "C1",
        "state": {
          "coding": [
            {
              "code": "1",
              "display": "State1",
              "description": "State1Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z1",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "2"
        },
        {
          "system": "Customer Defined",
          "value": "S2_2"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P3_3",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/patients"
      },
      "name": {
        "text": "John MN2 Jones",
        "family": "Jones",
        "given": [
          "John",
          "MN2"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/14/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD12",
          "SADD22",
          "SADD32"
        ],
        "city": "C2",
        "district": "C2",
        "state": {
          "coding": [
            {
              "code": "2",
              "display": "State2",
              "description": "State2Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z2",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/2/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "3"
        },
        {
          "system": "Customer Defined",
          "value": "S3_3"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P3_3",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/patients"
      },
      "name": {
        "text": "Hans MN3 Olsen",
        "family": "Olsen",
        "given": [
          "Hans",
          "MN3"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "01/27/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD13",
          "SADD23",
          "SADD33"
        ],
        "city": "C3",
        "district": "C3",
        "state": {
          "coding": [
            {
              "code": "0",
              "display": "State0",
              "description": "State0Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z3",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/3/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "4"
        },
        {
          "system": "Customer Defined",
          "value": "S4_4"
        }
      ],
      "studyName": "STUDY2",
      "studyIdentifier": "2",
      "patientIdentifier": "P4_4",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/patients"
      },
      "name": {
        "text": "Mary MN4 Johnson",
        "family": "Johnson",
        "given": [
          "Mary",
          "MN4"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "02/09/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD14",
          "SADD24",
          "SADD34"
        ],
        "city": "C4",
        "district": "C4",
        "state": {
          "coding": [
            {
              "code": "1",
              "display": "State1",
              "description": "State1Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z4",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/4/ethnicity"
      }
    },
    {
      "identifiers": [
        {
          "system": "CDM",
          "value": "5"
        },
        {
          "system": "Customer Defined",
          "value": "S5_5"
        }
      ],
      "studyName": "STUDY1",
      "studyIdentifier": "1",
      "patientIdentifier": "P4_4",
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/5/patients"
      },
      "name": {
        "text": "FN5 MN5 LN5",
        "family": "LN5",
        "given": [
          "FN5",
          "MN5"
        ]
      },
      "telecom": {
        "value": "[e-mail]",
        "use": {
          "coding": [
            {
              "code": "CNTCT_INFO_SUBTYP_EML",
              "display": "Email",
              "description": "Communicate electronically on the computer",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "gender": {
        "coding": [
          {
            "code": "1",
            "display": "Male",
            "description": "Male",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "birthDate": "02/22/1945",
      "deceasedBoolean": false,
      "maritalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "Married",
            "description": "Married",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "address": {
        "line": [
          "SADD15",
          "SADD25",
          "SADD35"
        ],
        "city": "C5",
        "district": "C5",
        "state": {
          "coding": [
            {
              "code": "2",
              "display": "State2",
              "description": "State2Desc",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "postalCode": "Z5",
        "country": {
          "coding": [
            {
              "code": "1",
              "display": "USA",
              "description": "United state of America",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "race": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/5/race"
      },
      "ethnicity": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/5/ethnicity"
      }
    }
  ],
  "count": 5,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects?id=1&id=2&id=3&id=4&id=5&limit=10&offset=0"
    }
  ]
}

Back to Top