Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Procedures for Subject Identifiers

get

/ohfapi/cg/v3.3/subjectapi/procedures

This endpoint supports the retrieval of Procedures for multiple Subject Identifiers passed. It returns all the Procedure related information like Code, Name, Type, Value, Analatomical Site, Procdeure Outcome, Encounter, Facility, Service Provider and Specialty.

Request

Supported Media Types

application/json
application/xml

Query Parameters

id: array

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Subject Identifiers

[0]: integer(int64)

{
    "name":"id",
    "in":"query",
    "description":"Subject Identifiers",
    "required":true,
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    },
    "collectionFormat":"multi",
    "maxItems":2147483647,
    "minItems":1
}

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

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Model for paginated collections of data.

Root Schema : PageableCollectionProcedure

Type: object

Model for paginated collections of data.

Show Source

count(optional): integer(int64)

Number of objects in the 'items' collection.
hasMore(optional): boolean

Default Value: false

A boolean indicating if more pages are available.
items(optional): array items

A collection of paged items.
links(optional): array link

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":{
                "name":"items",
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Procedure"
            }
        },
        "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.",
            "default":false
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "name":"link",
                "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 Procedure

Model for a Patient procedure object in CDM.

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

Nested Schema : link

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":{
        "name":"link",
        "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 : Procedure

Type: object

Model for a Patient procedure object in CDM.

Show Source

bodySite(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.
category(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.
code(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.
encounter(optional): object Encounter
identifier(optional): object Identifier

Identifier assigned by a given system
outcome(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.
patient(optional): object LinkedReference
patientcondition(optional): object LinkedReference
performedPeriod(optional): object DateRange
performer(optional): object Practitioner

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
subject(optional): object LinkedReference

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Procedure Identifier",
            "$ref":"#/definitions/Identifier"
        },
        "patient":{
            "example":"{href: '/patientapi/patients/{patientId}'}",
            "description":"A link containing href to retrieve Patient details",
            "$ref":"#/definitions/LinkedReference"
        },
        "subject":{
            "example":"{href: '/subjectapi/subjects/{subjectId}'}",
            "description":"A link containing href to retrieve Subject details",
            "$ref":"#/definitions/LinkedReference"
        },
        "category":{
            "description":"Category CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "code":{
            "description":"Code CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "bodySite":{
            "description":"Bodysite CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "performer":{
            "description":"Performer Details",
            "$ref":"#/definitions/Practitioner"
        },
        "performedPeriod":{
            "description":"Start and End Date Details",
            "$ref":"#/definitions/DateRange"
        },
        "encounter":{
            "description":"Encounter Details",
            "$ref":"#/definitions/Encounter"
        },
        "outcome":{
            "description":"Outcome CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        },
        "patientcondition":{
            "example":"{href: '/patientapi/conditions/{conditionId}'}",
            "description":"A link containing href to retrieve Condition details",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for a Patient procedure object in CDM."
}

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":{
                "$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 : Encounter

Type: object

Show Source

identifier(optional): object CdmIdentifier

Identifier assigned by a given system
location(optional): object Location
sequence(optional): object Number
type(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":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"Encounter type information for this encounter. Details such as encounter type code, name , description.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "location":{
            "description":"The location or facility details of the encounter.",
            "$ref":"#/definitions/Location"
        },
        "sequence":{
            "description":"The sequence or priority of the event within an encounter e.g. 1, 2 etc.",
            "$ref":"#/definitions/Number"
        }
    }
}

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 : LinkedReference

Type: object

Show Source

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

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

Nested Schema : DateRange

Type: object

Show Source

end(optional): string(date-time)
start(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Practitioner

Type: object

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.

Show Source

address(optional): object Address

Model for a postal address.
identifier(optional): object CdmIdentifier

Identifier assigned by a given system
name(optional): object HumanName

Model for a name of a human with text and parts information.
speciality(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.
specimenAliasIssuerFlag(optional): string

The flag that indicates that this Service Provider has issued Specimen Alias(es).
telecom(optional): object Telecom
type(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":{
        "identifier":{
            "description":"Healthcare service provider system identifier. It can include a service provider Row ID value or service provider unique identifier.",
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"The healthcare practitioner type or role, i.e. type/role code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "name":{
            "description":"A name associated with the person.",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"A contact detail for the practitioner. For example, the telephone number, email, or fax.",
            "$ref":"#/definitions/Telecom"
        },
        "address":{
            "description":"Where practitioner can be found/visited.",
            "$ref":"#/definitions/Address"
        },
        "speciality":{
            "description":"Detaile of the specific specialty of the practitioner, i.e. specialty code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "specimenAliasIssuerFlag":{
            "type":"string",
            "description":"The flag that indicates that this Service Provider has issued Specimen Alias(es)."
        }
    },
    "description":"Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility."
}

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":{
        "$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.
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."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

Nested Schema : CdmIdentifier

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 : Location

Type: object

Show Source

identifier(optional): object CdmIdentifier

Identifier assigned by a given system
name(optional): string

Name of the facility.
type(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":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the facility."
        },
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : Number

Type: object

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 : 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 : 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

Procedure(s) not found

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

The following example shows the contents of the response body in JSON format:

{

"resourceType": "Procedure",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients"
      },
      "subject": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1"
      },
      "category": {
        "coding": [
          {
            "code": "PROC_CD1",
            "display": "Procedure Code1",
            "description": "Code for the procedure"
          }
        ]
      },
      "code": {
        "coding": [
          {
            "code": "PROC_CD_CODE_1",
            "display": "PROC_CD_CODE_NM_1",
            "description": "PROC_CD Code description 1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "performer": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "performedPeriod": {
        "start": "11/14/1998",
        "end": "12/31/1998"
      },
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 1
      },
      "outcome": {
        "coding": [
          {
            "code": "OUTCM_CD_VIN1",
            "display": "OUTCM_CD_VIN_NM_1",
            "description": "OUTCM_CD_VIN_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1/patients"
      },
      "subject": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/subjects/1"
      },
      "category": {
        "coding": [
          {
            "code": "PROC_CD1",
            "display": "Procedure Code1",
            "description": "Code for the procedure"
          }
        ]
      },
      "code": {
        "coding": [
          {
            "code": "PROC_CD_CODE_1",
            "display": "PROC_CD_CODE_NM_1",
            "description": "PROC_CD Code description 1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "performer": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "performedPeriod": {
        "start": "11/14/1998",
        "end": "12/31/1998"
      },
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 1
      },
      "outcome": {
        "coding": [
          {
            "code": "OUTCM_CD_VIN1",
            "display": "OUTCM_CD_VIN_NM_1",
            "description": "OUTCM_CD_VIN_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      }
    }
  ],
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://loalhost:7010/ohfapi/cg/v3.3/subjectapi/procedures?id=1&id=2&id=3&id=4&limit=2&offset=0"
    },
    {
      "rel": "next",
      "href": "http://loalhost:7010/ohfapi/cg/v3.3/subjectapi/procedures?offset=2&limit=2&id=1&id=2&id=3&id=4"
    }
  ]
}