HDR FHIR API

GET Library Resource Bundle

get

/oracle-fhir-server/fhir/Library

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
composed-of(optional): string

What resource is being referenced
content-type(optional): string

The type of content in the library (e.g. text/cql)
context(optional): string

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

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

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

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

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

The library publication date
depends-on(optional): string

What resource is being referenced
derived-from(optional): string

What resource is being referenced
description(optional): string

The description of the library
effective(optional): string(date)

The time during which the library is intended to be in use
identifier(optional): string

External identifier for the library
jurisdiction(optional): string

Intended jurisdiction for the library
name(optional): string

Computationally friendly name of the library
predecessor(optional): string

What resource is being referenced
publisher(optional): string

Name of the publisher of the library
status(optional): string

The current status of the library
successor(optional): string

What resource is being referenced
title(optional): string

The human-friendly name of the library
topic(optional): string

Topics associated with the module
type(optional): string

The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)
url(optional): string

The uri that identifies the library
version(optional): string

The business version of the library

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Library

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

Nested Schema : Library

Type: object

Show Source

content: array content

Minimum Number of Items: 1

Unique Items Required: true
dataRequirement: array dataRequirement

Minimum Number of Items: 1

Unique Items Required: true
date: string

Minimum Length: 1
description: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
relatedArtifact: array relatedArtifact

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
title: string

Minimum Length: 1
topic: array topic

Minimum Number of Items: 1

Unique Items Required: true
type: object Claim_priority
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "content",
        "dataRequirement",
        "date",
        "description",
        "id",
        "identifier",
        "meta",
        "relatedArtifact",
        "resourceType",
        "status",
        "text",
        "title",
        "topic",
        "type",
        "version"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Library_identifier"
            },
            "minItems":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/Claim_priority"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "topic":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "relatedArtifact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Library_relatedArtifact"
            },
            "minItems":1
        },
        "dataRequirement":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Library_dataRequirement"
            },
            "minItems":1
        },
        "content":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Contract_contentAttachment"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : content

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Contract_contentAttachment

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

Nested Schema : dataRequirement

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Library_dataRequirement

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Library_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Library_identifier"
    },
    "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 : relatedArtifact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Library_relatedArtifact

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Library_relatedArtifact"
    },
    "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 : topic

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

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

Nested Schema : Claim_priority

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : Contract_contentAttachment

Type: object

Show Source

contentType: string

Minimum Length: 1
url: string

Minimum Length: 1

{
    "required":[
        "contentType",
        "url"
    ],
    "properties":{
        "contentType":{
            "type":"string",
            "minLength":1
        },
        "url":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Library_dataRequirement

Type: object

Show Source

codeFilter(optional): array codeFilter

Minimum Number of Items: 1

Unique Items Required: true
type: string

Minimum Length: 1

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

Nested Schema : codeFilter

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Library_codeFilter

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

Nested Schema : Library_codeFilter

Type: object

Show Source

path: string

Minimum Length: 1
valueSet: string

Minimum Length: 1

{
    "required":[
        "path",
        "valueSet"
    ],
    "properties":{
        "path":{
            "type":"string",
            "minLength":1
        },
        "valueSet":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Library_identifier

Type: object

Show Source

use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "use",
        "value"
    ],
    "properties":{
        "use":{
            "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 : Library_relatedArtifact

Type: object

Show Source

resource: string

Minimum Length: 1
type: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_interaction_1

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

Nested Schema : CapabilityStatement_interaction_1

Type: object

Show Source

code: string

Minimum Length: 1

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