HDR FHIR API

GET StructureMap Resource Bundle

get

/oracle-fhir-server/fhir/StructureMap

This endpoint supports the retrieval of StructureMap resource list.It returns Bundle of StructureMap 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 structure map
context-quantity(optional): integer

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

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

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

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

The structure map publication date
description(optional): string

The description of the structure map
identifier(optional): string

External identifier for the structure map
jurisdiction(optional): string

Intended jurisdiction for the structure map
name(optional): string

Computationally friendly name of the structure map
publisher(optional): string

Name of the publisher of the structure map
status(optional): string

The current status of the structure map
title(optional): string

The human-friendly name of the structure map
url(optional): string

The uri that identifies the structure map
version(optional): string

The business version of the structure map

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object StructureMap

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

Nested Schema : StructureMap

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

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
jurisdiction: array jurisdiction

Minimum Number of Items: 1

Unique Items Required: true
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
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":[
        "contact",
        "date",
        "description",
        "group",
        "id",
        "identifier",
        "jurisdiction",
        "name",
        "publisher",
        "resourceType",
        "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
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/GraphDefinition_contact"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "jurisdiction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "group":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/StructureMap_group"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : contact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object GraphDefinition_contact

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

Nested Schema : group

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object StructureMap_group

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

Nested Schema : identifier

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

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

Type: object

Show Source

telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "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 : StructureMap_group

Type: object

Show Source

documentation: string

Minimum Length: 1
input(optional): array input

Minimum Number of Items: 1

Unique Items Required: true
name: string

Minimum Length: 1
rule(optional): array rule

Minimum Number of Items: 1

Unique Items Required: true
typeMode: string

Minimum Length: 1

{
    "required":[
        "documentation",
        "name",
        "typeMode"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "typeMode":{
            "type":"string",
            "minLength":1
        },
        "documentation":{
            "type":"string",
            "minLength":1
        },
        "input":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/StructureMap_input"
            },
            "minItems":1
        },
        "rule":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/StructureMap_rule"
            },
            "minItems":1
        }
    }
}

Nested Schema : input

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object StructureMap_input

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

Nested Schema : rule

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object StructureMap_rule

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

Nested Schema : StructureMap_input

Type: object

Show Source

mode: string

Minimum Length: 1
name: string

Minimum Length: 1

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

Nested Schema : StructureMap_rule

Type: object

Show Source

name: string

Minimum Length: 1
source(optional): array source

Minimum Number of Items: 1

Unique Items Required: true
target(optional): array target

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : source

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object StructureMap_source

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

Nested Schema : target

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object StructureMap_target

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

Nested Schema : StructureMap_source

Type: object

Show Source

context: string

Minimum Length: 1
element: string

Minimum Length: 1
type: string

Minimum Length: 1
variable: string

Minimum Length: 1

{
    "required":[
        "context",
        "element",
        "type",
        "variable"
    ],
    "properties":{
        "context":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "element":{
            "type":"string",
            "minLength":1
        },
        "variable":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : StructureMap_target

Type: object

Show Source

context: string

Minimum Length: 1
contextType: string

Minimum Length: 1
element: string

Minimum Length: 1
transform: string

Minimum Length: 1

{
    "required":[
        "context",
        "contextType",
        "element",
        "transform"
    ],
    "properties":{
        "context":{
            "type":"string",
            "minLength":1
        },
        "contextType":{
            "type":"string",
            "minLength":1
        },
        "element":{
            "type":"string",
            "minLength":1
        },
        "transform":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AdverseEvent_category

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/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

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