HDR FHIR API

GET ImplementationGuide Resource Bundle

get

/oracle-fhir-server/fhir/ImplementationGuide

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
context(optional): string

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

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

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

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

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

The implementation guide publication date
depends-on(optional): string

Identity of the IG that this depends on
description(optional): string

The description of the implementation guide
experimental(optional): string

For testing purposes, not real usage
global(optional): string

Profile that all resources must conform to
jurisdiction(optional): string

Intended jurisdiction for the implementation guide
name(optional): string

Computationally friendly name of the implementation guide
publisher(optional): string

Name of the publisher of the implementation guide
resource(optional): string

Location of the resource
status(optional): string

The current status of the implementation guide
title(optional): string

The human-friendly name of the implementation guide
url(optional): string

The uri that identifies the implementation guide
version(optional): string

The business version of the implementation guide

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ImplementationGuide

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

Nested Schema : ImplementationGuide

Type: object

Show Source

contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
copyright: string

Minimum Length: 1
date: string

Minimum Length: 1
definition: object ImplementationGuide_definition
dependsOn: array dependsOn

Minimum Number of Items: 1

Unique Items Required: true
description: string

Minimum Length: 1
experimental: boolean
fhirVersion: array fhirVersion
global: array global

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
jurisdiction: array jurisdiction

Minimum Number of Items: 1

Unique Items Required: true
license: string

Minimum Length: 1
manifest: object ImplementationGuide_manifest
name: string

Minimum Length: 1
packageId: string

Minimum Length: 1
publisher: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
url: string

Minimum Length: 1
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "contact",
        "copyright",
        "date",
        "definition",
        "dependsOn",
        "description",
        "experimental",
        "fhirVersion",
        "global",
        "id",
        "jurisdiction",
        "license",
        "manifest",
        "name",
        "packageId",
        "publisher",
        "resourceType",
        "status",
        "text",
        "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
        },
        "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
        },
        "jurisdiction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "copyright":{
            "type":"string",
            "minLength":1
        },
        "packageId":{
            "type":"string",
            "minLength":1
        },
        "license":{
            "type":"string",
            "minLength":1
        },
        "fhirVersion":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "dependsOn":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_dependsOn"
            },
            "minItems":1
        },
        "global":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_global"
            },
            "minItems":1
        },
        "definition":{
            "$ref":"#/definitions/ImplementationGuide_definition"
        },
        "manifest":{
            "$ref":"#/definitions/ImplementationGuide_manifest"
        }
    },
    "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 : ImplementationGuide_definition

Type: object

Show Source

grouping: array grouping

Minimum Number of Items: 1

Unique Items Required: true
page: object ImplementationGuide_definition_page
parameter: array parameter

Minimum Number of Items: 1

Unique Items Required: true
resource: array resource

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "grouping",
        "page",
        "parameter",
        "resource"
    ],
    "properties":{
        "grouping":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_definition_grouping"
            },
            "minItems":1
        },
        "resource":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_definition_resource"
            },
            "minItems":1
        },
        "page":{
            "$ref":"#/definitions/ImplementationGuide_definition_page"
        },
        "parameter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_definition_parameter"
            },
            "minItems":1
        }
    }
}

Nested Schema : dependsOn

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_dependsOn

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

Nested Schema : fhirVersion

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : global

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_global

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

Nested Schema : jurisdiction

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

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

Nested Schema : ImplementationGuide_manifest

Type: object

Show Source

image: array image
other: array other
page: array page

Minimum Number of Items: 1

Unique Items Required: true
rendering: string

Minimum Length: 1
resource: array resource

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "image",
        "other",
        "page",
        "rendering",
        "resource"
    ],
    "properties":{
        "rendering":{
            "type":"string",
            "minLength":1
        },
        "resource":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_manifest_resource"
            },
            "minItems":1
        },
        "page":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_manifest_page"
            },
            "minItems":1
        },
        "image":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "other":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        }
    }
}

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

Nested Schema : grouping

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_definition_grouping

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

Nested Schema : ImplementationGuide_definition_page

Type: object

Show Source

generation: string

Minimum Length: 1
nameUrl: string

Minimum Length: 1
page: array page

Minimum Number of Items: 1

Unique Items Required: true
title: string

Minimum Length: 1

{
    "required":[
        "generation",
        "nameUrl",
        "page",
        "title"
    ],
    "properties":{
        "nameUrl":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "generation":{
            "type":"string",
            "minLength":1
        },
        "page":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImplementationGuide_definition_page_page"
            },
            "minItems":1
        }
    }
}

Nested Schema : parameter

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_definition_parameter

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

Nested Schema : resource

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_definition_resource

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

Nested Schema : ImplementationGuide_definition_grouping

Type: object

Show Source

description: string

Minimum Length: 1
name: string

Minimum Length: 1

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

Nested Schema : page

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_definition_page_page

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

Nested Schema : ImplementationGuide_definition_page_page

Type: object

Show Source

generation: string

Minimum Length: 1
nameUrl: string

Minimum Length: 1
title: string

Minimum Length: 1

{
    "required":[
        "generation",
        "nameUrl",
        "title"
    ],
    "properties":{
        "nameUrl":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "generation":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ImplementationGuide_definition_parameter

Type: object

Show Source

code: string

Minimum Length: 1
value: string

Minimum Length: 1

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

Nested Schema : ImplementationGuide_definition_resource

Type: object

Show Source

description: string

Minimum Length: 1
exampleCanonical: string

Minimum Length: 1
name: string

Minimum Length: 1
reference(optional): object Account_coverage

{
    "required":[
        "description",
        "exampleCanonical",
        "name"
    ],
    "properties":{
        "reference":{
            "$ref":"#/definitions/Account_coverage"
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "exampleCanonical":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : ImplementationGuide_dependsOn

Type: object

Show Source

uri: string

Minimum Length: 1

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

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : ImplementationGuide_global

Type: object

Show Source

profile: string

Minimum Length: 1
type: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_jurisdiction

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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

Nested Schema : image

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : other

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : page

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_manifest_page

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

Nested Schema : resource

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImplementationGuide_manifest_resource

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

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : ImplementationGuide_manifest_page

Type: object

Show Source

anchor(optional): array anchor
name: string

Minimum Length: 1
title: string

Minimum Length: 1

{
    "required":[
        "name",
        "title"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "anchor":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        }
    }
}

Nested Schema : anchor

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : ImplementationGuide_manifest_resource

Type: object

Show Source

exampleCanonical: string

Minimum Length: 1
reference(optional): object Account_coverage
relativePath: string

Minimum Length: 1

{
    "required":[
        "exampleCanonical",
        "relativePath"
    ],
    "properties":{
        "reference":{
            "$ref":"#/definitions/Account_coverage"
        },
        "exampleCanonical":{
            "type":"string",
            "minLength":1
        },
        "relativePath":{
            "type":"string",
            "minLength":1
        }
    }
}