Jump to

• Request
• Response

Get a related person by ID

get

/RelatedPerson/{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 an individual related person 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 : RelatedPerson

Type: object

Show Source

• active(required): boolean
  (USCDI) Whether this related person's record is in active use.
• address: array address
  (USCDI) The address where the related person can be contacted or visited.
• id(required): string
• name: array name
  (USCDI) A name associated with the person.
• patient(required): patient
  (USCDI) The patient this person is related to.
• relationship: array relationship
  (USCDI) The nature of the relationship.
• resourceType(required): string
  Allowed Values: [ "RelatedPerson" ]
• telecom: array telecom
  (USCDI) A contact detail for the person.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "active",
        "patient"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "RelatedPerson"
            ]
        },
        "id":{
            "type":"string"
        },
        "active":{
            "type":"boolean",
            "description":"(USCDI) Whether this related person's record is in active use."
        },
        "patient":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The patient this person is related to."
        },
        "relationship":{
            "type":"array",
            "description":"(USCDI) The nature of the relationship.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "name":{
            "type":"array",
            "description":"(USCDI) A name associated with the person.",
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "description":"(USCDI) A contact detail for the person.",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            }
        },
        "address":{
            "type":"array",
            "description":"(USCDI) The address where the related person can be contacted or visited.",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        }
    }
}

Nested Schema : address

Type: array

(USCDI) The address where the related person can be contacted or visited.

Show Source

• Array of: object Address

{
    "type":"array",
    "description":"(USCDI) The address where the related person can be contacted or visited.",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : name

Type: array

(USCDI) A name associated with the person.

Show Source

• Array of: object HumanName

{
    "type":"array",
    "description":"(USCDI) A name associated with the person.",
    "items":{
        "$ref":"#/components/schemas/HumanName"
    }
}

Nested Schema : patient

(USCDI) The patient this person is related to.

Match All

(USCDI) The patient this person is related to.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The patient this person is related to."
}

Nested Schema : relationship

Type: array

(USCDI) The nature of the relationship.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The nature of the relationship.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : telecom

Type: array

(USCDI) A contact detail for the person.

Show Source

• Array of: object ContactPoint

{
    "type":"array",
    "description":"(USCDI) A contact detail for the person.",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
  The name of city, town, and so on.
• country: string
  The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code.
• line: array line
  The street name, number, direction, P.O. Box, and so on.
• postalCode: string
  The U.S. ZIP Codes.
• state: string
  The subunit of the country (abbreviations are supported).

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"The street name, number, direction, P.O. Box, and so on.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"The name of city, town, and so on."
        },
        "state":{
            "type":"string",
            "description":"The subunit of the country (abbreviations are supported)."
        },
        "postalCode":{
            "type":"string",
            "description":"The U.S. ZIP Codes."
        },
        "country":{
            "type":"string",
            "description":"The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code."
        }
    }
}

Nested Schema : line

Type: array

The street name, number, direction, P.O. Box, and so on.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The street name, number, direction, P.O. Box, and so on.",
    "items":{
        "type":"string"
    }
}

Nested Schema : HumanName

Type: object

Show Source

• family(required): string
  The family name (often called the surname).

{
    "type":"object",
    "required":[
        "family"
    ],
    "properties":{
        "family":{
            "type":"string",
            "description":"The family name (often called the surname)."
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

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

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

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

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : ContactPoint

Type: object

Show Source

• system: string
  (USCDI) The following values are supported:

  • phone
  • fax
  • email
  • pager
  • url
  • sms
  • other
• value: string
  The actual contact point details.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>phone</code></li>\n    <li><code>fax</code></li>\n    <li><code>email</code></li>\n    <li><code>pager</code></li>\n    <li><code>url</code></li>\n    <li><code>sms</code></li>\n    <li><code>other</code></li>\n  </ul>\n"
        },
        "value":{
            "type":"string",
            "description":"The actual contact point details."
        }
    }
}

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