HDR FHIR API

GET NamingSystem Resource Bundle

get

/oracle-fhir-server/fhir/NamingSystem

This endpoint supports the retrieval of NamingSystem resource list.It returns Bundle of NamingSystem resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
contact(optional): string

Name of an individual to contact
context(optional): string

A use context assigned to the naming system
context-quantity(optional): integer

A quantity- or range-valued use context assigned to the naming system
context-type(optional): string

A type of use context assigned to the naming system
context-type-quantity(optional): string

A use context type and quantity- or range-based value assigned to the naming system
context-type-value(optional): string

A use context type and value assigned to the naming system
date(optional): string(date)

The naming system publication date
description(optional): string

The description of the naming system
id-type(optional): string

oid | uuid | uri | other
jurisdiction(optional): string

Intended jurisdiction for the naming system
kind(optional): string

codesystem | identifier | root
name(optional): string

Computationally friendly name of the naming system
period(optional): string(date)

When is identifier valid?
publisher(optional): string

Name of the publisher of the naming system
responsible(optional): string

Who maintains system namespace?
status(optional): string

The current status of the naming system
telecom(optional): string

Contact details for individual or organization
type(optional): string

e.g. driver, provider, patient, bank etc.
value(optional): string

The unique identifier

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object NamingSystem

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

Nested Schema : NamingSystem

Type: object

Show Source

contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
date: string

Minimum Length: 1
description: string

Minimum Length: 1
id: string

Minimum Length: 1
kind: string

Minimum Length: 1
meta: object Account_meta
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
responsible: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
uniqueId: array uniqueId

Minimum Number of Items: 1

Unique Items Required: true

{
    "type":"object",
    "required":[
        "contact",
        "date",
        "description",
        "id",
        "kind",
        "meta",
        "name",
        "publisher",
        "resourceType",
        "responsible",
        "status",
        "text",
        "uniqueId"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "kind":{
            "type":"string",
            "minLength":1
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CapabilityStatement_contact"
            },
            "minItems":1
        },
        "responsible":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "uniqueId":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/NamingSystem_uniqueId"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : contact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_contact

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/CapabilityStatement_contact"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : uniqueId

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object NamingSystem_uniqueId

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/NamingSystem_uniqueId"
    },
    "minItems":1
}

Nested Schema : CapabilityStatement_contact

Type: object

Show Source

name: string

Minimum Length: 1
telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        }
    }
}

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_identifier"
    },
    "minItems":1
}

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : NamingSystem_uniqueId

Type: object

Show Source

preferred: boolean
type: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "preferred",
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        },
        "preferred":{
            "type":"boolean"
        }
    }
}