Jump to

• Request
• Response

Get media by ID

get

/Media/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves individual media content 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 credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : Media

Type: object

Show Source

• content(required): object content
• id(required): string
• resourceType(required): string
  Allowed Values: [ "Media" ]
• status(required): string
  The status of the media.
• subject(required): subject
  The subject of the media. Usually, but not always, the subject is the patient.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "subject",
        "content"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Media"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"The status of the media."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The subject of the media. Usually, but not always, the subject is the patient."
        },
        "content":{
            "type":"object",
            "required":[
                "contentType"
            ],
            "properties":{
                "contentType":{
                    "type":"string",
                    "description":"The type of the data in the attachment, which allows a method to interpret or render the data."
                },
                "data":{
                    "type":"string",
                    "description":"The base64-encoded content of the media."
                },
                "size":{
                    "type":"integer",
                    "description":"The number of bytes of data that composes this content (before base64 encoding, if applicable)."
                }
            }
        }
    }
}

Nested Schema : content

Type: object

Show Source

• contentType(required): string
  The type of the data in the attachment, which allows a method to interpret or render the data.
• data: string
  The base64-encoded content of the media.
• size: integer
  The number of bytes of data that composes this content (before base64 encoding, if applicable).

{
    "type":"object",
    "required":[
        "contentType"
    ],
    "properties":{
        "contentType":{
            "type":"string",
            "description":"The type of the data in the attachment, which allows a method to interpret or render the data."
        },
        "data":{
            "type":"string",
            "description":"The base64-encoded content of the media."
        },
        "size":{
            "type":"integer",
            "description":"The number of bytes of data that composes this content (before base64 encoding, if applicable)."
        }
    }
}

Nested Schema : subject

The subject of the media. Usually, but not always, the subject is the patient.

Match All

The subject of the media. Usually, but not always, the subject is the patient.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The subject of the media. Usually, but not always, the subject is the patient."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

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

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top