Edvak Docs
HomeFHIR API
CCDA API
HomeFHIR API
CCDA API
LinkedIn
  1. Related Person
  • Getting Started
    • Introduction
    • Supported Standards, Frameworks & API Versions
    • Standardized API Details – Patient and Population Services
    • Environment Endpoints
    • Errors and Exceptions
  • Authentication & Authorization
    • Overview – Authorization & Security Standards
    • Authorization
      • Well-known configuration
      • Authorize
      • Request
      • Introspect
  • Developer Onboarding
    • App Registration & Credentials
  • API Usage Guidelines
    • FHIR API Interaction Conventions
  • US Core & USCDI Mapping
    • Overview
  • APIs
    • Allergies and Intolerances
      • By Patient ID
      • By Resource ID
      • Create an AllergyIntolerance
      • Update an AllergyIntolerance
    • Assessment and Plan of Treatment
      • By Patient and Category
      • Create a CarePlan
      • Update a CarePlan
    • Care Team Members
      • Care Teams
        • By Patient and Status
        • By Patient and Role
        • Create a CareTeam
        • Update a CareTeam
      • Related Person
        • By ID
          GET
        • By Patient
          GET
        • Create a RelatedPerson
          POST
        • Update a RelatedPerson
          PUT
      • Practitioner
        • By Name
        • By Resource ID
        • By Identifier
        • Create a Practitioner
        • Update a Practitioner
      • Practioner Role
        • By Specialty
        • By Practitioner ID
        • By Practitioner Identifier
        • By Practitioner Name
        • Create a PractitionerRole
        • Update a PractitionerRole
      • Location
        • By Name
        • By Address
        • By City
        • By State
        • By Postal Code
        • Create a Location
        • Update a Location
      • Organization
        • By Name
        • By Address
        • Create an Organization
        • Update an Organization
    • Clinical Notes
      • Document References
        • By ID
        • By Patient
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient and Type
        • By Patient and Status
        • By Patient, Type, and Period
        • Create a DocumentReference
        • Update a DocumentReference
      • Diagnostic Report
        • By Patient ID
        • By Patient and Category
        • By Patient and Code
        • By Patient, Category, and Date
        • By Patient and Status
    • Goals
      • Get Goals by Patient ID
      • Get Goal by ID
      • Get Goals by Patient and Lifecycle Status
      • Get Goals by Patient and Target Date
      • Get Goals by Patient and Description
      • Get Diagnostic Reports by Patient, Code, and Date
      • Create a Goal
      • Update a Goal
    • Clinical Tests
      • Observation
        • By Patient and Category
        • By Patient and Code
        • By Patient, Code, and Date
        • By Patient, Category, and Date
        • By Patient, Category, and Status
      • Lab Diagnostic Report
        • By Patient
        • By Patient and Code
        • By Patient, Code, and Date
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient and Status
    • Diagnostic Imaging
      • Imaging Observations
        • By Patient
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient, Category, and Status
        • By Patient and Code
        • By Patient, Code and Date
      • Create a DiagnosticReport
      • Update a DiagnosticReport
    • Encounter Information
      • Encounter
        • By ID
        • By Patient ID
        • By Patient and Date Range
        • By Identifier
        • By Patient and Class
        • By Patient and Type
        • By Patient and Location
        • By Patient and Status
        • By Patient and Discharge Disposition
        • Create an Encounter
        • Update an Encounter
      • Encounter Diagnosis
        • By Patient ID
        • By Patient ID and Clinical Status
        • By Patient ID and Category
        • By Patient ID and Code
        • By Patient ID and Asserted Date
        • By Patient ID, Category, and Encounter
        • By Patient ID and Onset Date
        • By Patient ID and Recorded Date
        • By Patient ID and Abatement Date
    • Group
      • By ID
      • By $export (Group-level Bulk Export)
      • Create a Group
      • Update a Group
    • Health Concerns
      • By Patient
      • By Patient and Clinical Status
      • By Patient and Category
      • By Patient and Category and Encounter
      • By Patient and Code
      • By Patient and Asserted Date
      • By Patient and Onset Date
      • By Patient and Recorded Date
      • By Patient and Abatement Date
      • Create a Condition
      • Update a Condition
    • Implantable Devices
      • By Patient
      • By ID
      • By Patient and Type
      • Create a Device
      • Update a Device
    • Immunizations
      • By ID
      • By Patient
      • By Patient and Date
      • By Patient and Status
      • Create an Immunization
      • Update an Immunization
    • Laboratory
      • Laboratory Result Observation
        • By ID
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient, Category, and Status
        • By Patient and Code
        • By Patient, Code, and Date
        • Create an Observation
        • Update an Observation
    • Medications
      • Medications
        • By ID
        • By Patient
        • Create a Medication
        • Update a Medication
      • Medication Request
        • Get MedicationRequests by Patient
        • Get MedicationRequest by ID
        • Get MedicationRequests by Patient and Intent
        • Get MedicationRequests by Patient, Intent, and Encounter
        • Get MedicationRequests by Patient, Intent, and AuthoredOn Date
        • Create a MedicationRequest
        • Update a MedicationRequest
    • Patient Demographics
      • Patient
        • Get Patient by ID
        • Get Patient by Identifier
        • Get Patient by Name
        • Get Patient by Birthdate and Name
        • Get Patient by Gender and Name
        • Get Patient by Birthdate and Family Name
        • Create a Patient
        • Update a Patient
      • Observation Sexual Orientation
        • Get Observations by Patient ID
        • Get Observation by ID
        • Get Observations by Patient and Code
        • Get Observations by Patient, Code, and Date
        • Get Observations by Patient, Code, and Date
    • Procedures
      • Procedure
        • Get Procedures by Patient
        • Get Procedure by ID
        • Get Procedures by Patient and Date
        • Get Procedures by Patient and Status
        • Get Procedures by Patient, Code, and Date
        • Create a Procedure
        • Update a Procedure
      • Service Request
        • Get ServiceRequests by Patient
        • Get ServiceRequest by ID
        • Get ServiceRequests by Patient and Category
        • Get ServiceRequests by Patient and Code
        • Get ServiceRequests by Patient, Category, and Authored Date
        • Get ServiceRequests by Patient, Code, and Authored Date
        • Get ServiceRequests by Patient and Status
        • Create a ServiceRequest
        • Update a ServiceRequest
    • Provenance
      • Provenance
        • Get Provenance by ID
        • Get resource and Provenance using _revinclude
      • Create a Provenance
      • Update a Provenance
    • Smoking Status
      • Smoking Status
        • Get Observation by ID
        • Get Observations by Patient
        • Get Smoking Status by Patient and Code
    • Vital Signs
      • Vital Signs
        • Get Observation by ID
        • Get Observations by Patient and Category
        • Get Observations by Patient and Code
        • Get Observations by Patient, Category, and Date
        • Get Observations by Patient, Category, and Status
        • Get Observations by Patient, Code, and Date
  • Legal & Compliance
    • API Terms of Use
  1. Related Person

Create a RelatedPerson

Sandbox
https://fhir-dev.edvak.com/api/v1/fhir/r4
Sandbox
https://fhir-dev.edvak.com/api/v1/fhir/r4
POST
https://fhir-dev.edvak.com/api/v1/fhir/r4
/RelatedPerson
Creates a new RelatedPerson. Do not send an id -- the server assigns one and returns it in the Location header and in the response body.

Request

Authorization
OAuth 2.0
Password
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: https://fhir-dev.edvak.com/api/v1/fhir/r4/realms/EDVAK/protocol/openid-connect/token
or
Header Params

Body Params
application/fhir+json
Required

Example
{
    "resourceType": "RelatedPerson",
    "active": true,
    "patient": {
        "reference": "Patient/example"
    },
    "relationship": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
                    "code": "N",
                    "display": "Next-of-Kin"
                }
            ]
        }
    ],
    "name": [
        {
            "family": "Shaw",
            "given": [
                "Robert"
            ]
        }
    ]
}

Responses

🟢200
application/fhir+json
Conditional create matched an existing resource. Nothing was created.
Bodyapplication/fhir+json

Example
{
    "resourceType": "RelatedPerson",
    "active": true,
    "patient": {
        "reference": "Patient/example"
    },
    "relationship": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
                    "code": "N",
                    "display": "Next-of-Kin"
                }
            ]
        }
    ],
    "name": [
        {
            "family": "Shaw",
            "given": [
                "Robert"
            ]
        }
    ]
}
🟢201
🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠422UnprocessableEntity
Modified at 2026-08-27 21:46:29
Previous
By Patient
Next
Update a RelatedPerson
Built with