HDR FHIR API

Update TerminologyCapabilities Resource

put

/oracle-fhir-server/fhir/TerminologyCapabilities/{id}

This api lets you create a new current version for an existing TerminologyCapabilities resource or creates an initial version if no TerminologyCapabilities resource already exists for the given id.

Request

Path Parameters

id: string

Root Schema : TerminologyCapabilities

Type: object

Show Source

codeSearch: string

Minimum Length: 1
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
date: string

Minimum Length: 1
description: string

Minimum Length: 1
experimental: boolean
id: string

Minimum Length: 1
implementation: object CapabilityStatement_implementation
kind: string

Minimum Length: 1
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
software: object TerminologyCapabilities_software
status: string

Minimum Length: 1
text: object Account_text
title: string

Minimum Length: 1
url: string

Minimum Length: 1
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "codeSearch",
        "contact",
        "date",
        "description",
        "experimental",
        "id",
        "implementation",
        "kind",
        "name",
        "publisher",
        "resourceType",
        "software",
        "status",
        "text",
        "title",
        "url",
        "version"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "experimental":{
            "type":"boolean"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CapabilityStatement_contact"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "kind":{
            "type":"string",
            "minLength":1
        },
        "software":{
            "$ref":"#/definitions/TerminologyCapabilities_software"
        },
        "implementation":{
            "$ref":"#/definitions/CapabilityStatement_implementation"
        },
        "codeSearch":{
            "type":"string",
            "minLength":1
        }
    },
    "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 : CapabilityStatement_implementation

Type: object

Show Source

description: string

Minimum Length: 1
url: string

Minimum Length: 1

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

Nested Schema : TerminologyCapabilities_software

Type: object

Show Source

name: string

Minimum Length: 1
version: string

Minimum Length: 1

{
    "required":[
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "version":{
            "type":"string",
            "minLength":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 : 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
        }
    }
}

Response

200 Response

Success