Jump to

• Request
• Response

Get a provenance by ID

get

/Provenance/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual provenance by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Provenance

Type: object

The Oracle US Core Provenance returned by read and search operations.

Show Source

• agent(required): array agent
  Minimum Number of Items: 1
• entity: array entity
• id(required): string
• meta(required): object meta
• recorded(required): string (date-time)
• resourceType(required): string
  Allowed Values: [ "Provenance" ]
• target(required): array target
  Minimum Number of Items: 1

{
    "type":"object",
    "description":"The Oracle US Core Provenance returned by read and search operations.",
    "required":[
        "resourceType",
        "id",
        "meta",
        "target",
        "recorded",
        "agent"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "target":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/ReferenceForProvenance"
            }
        },
        "recorded":{
            "type":"string",
            "format":"date-time"
        },
        "agent":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/AgentForProvenance"
            }
        },
        "entity":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntityForProvenance"
            }
        }
    }
}

Nested Schema : agent

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object AgentForProvenance

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/AgentForProvenance"
    }
}

Nested Schema : entity

Type: array

Show Source

• Array of: object EntityForProvenance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntityForProvenance"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : target

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object ReferenceForProvenance

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/ReferenceForProvenance"
    }
}

Nested Schema : AgentForProvenance

Type: object

Show Source

• display: string
• onBehalfOf: object ReferenceForProvenance
• role: array role
• type: object CodeableConceptForProvenance
• who(required): object ReferenceForProvenance

{
    "type":"object",
    "required":[
        "who"
    ],
    "additionalProperties":false,
    "properties":{
        "type":{
            "$ref":"#/components/schemas/CodeableConceptForProvenance"
        },
        "role":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConceptForProvenance"
            }
        },
        "who":{
            "$ref":"#/components/schemas/ReferenceForProvenance"
        },
        "onBehalfOf":{
            "$ref":"#/components/schemas/ReferenceForProvenance"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceForProvenance

Type: object

Show Source

• extension: array extension
• reference: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProvenance"
            }
        },
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : role

Type: array

Show Source

• Array of: object CodeableConceptForProvenance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConceptForProvenance"
    }
}

Nested Schema : CodeableConceptForProvenance

Type: object

Show Source

• coding: array coding
• extension: array extension
• text: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProvenance"
            }
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProvenance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProvenance"
    }
}

Nested Schema : ExtensionForProvenance

Type: object

Show Source

• url(required): string
• valueCode: string

{
    "type":"object",
    "required":[
        "url"
    ],
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProvenance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProvenance"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : EntityForProvenance

Type: object

Show Source

• _role: object PrimitiveElementForProvenance
• display: string
• role: string
• what(required): object ReferenceForProvenance

{
    "type":"object",
    "required":[
        "what"
    ],
    "additionalProperties":false,
    "properties":{
        "role":{
            "type":"string"
        },
        "_role":{
            "$ref":"#/components/schemas/PrimitiveElementForProvenance"
        },
        "what":{
            "$ref":"#/components/schemas/ReferenceForProvenance"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : PrimitiveElementForProvenance

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProvenance"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProvenance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProvenance"
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top