Get a related person record by ID
get
/RelatedPerson/{ID}
Retrieves an individual related person record by the associated related person ID.
Note: Duplicate relationships are only represented once. This operation supports the following authorization types:Request
Path Parameters
-
ID(required): string
The logical resource ID associated with the resource.
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
Supported Media Types
- application/fhir+json
Default Response
Example retrieval of a patient-level related person record.
Example Request:GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724068-12724066
{
'resourceType': 'RelatedPerson',
'id': '12724066-12724068',
'meta': {
'versionId': 145,
'lastUpdated': '2021-03-22T14:12:37.000Z'
},
'text': {
'status': 'extensions',
'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Related Person</b></p><p><b>Name</b>: SMART, NANCY</p><p><b>DOB</b>: Aug 11, 1980</p><p><b>Gender</b>: female</p><p><b>Patient</b>: SMART, HAILEY</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship</b>: Family Member</p><p><b>Relationship Level</b>: Patient</p></div>'
},
'extension': [
{
'valueCodeableConcept': {
'coding': [
{
'system': 'http://hl7.org/fhir/resource-types',
'code': 'Patient',
'display': 'Patient'
}
],
'text': 'Patient'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level'
}
],
'identifier': [
{
'id': 'CI-490060520-1',
'use': 'usual',
'type': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4',
'code': '22',
'display': 'Military Id',
'userSelected': true
}
],
'text': 'Military Id'
},
'system': 'urn:oid:2.16.840.1.113883.3.42.10001.100001.12',
'value': '1000000105'
},
{
'id': 'CI-490068325-2',
'use': 'usual',
'type': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4',
'code': '2553236771',
'display': 'Federated Person Principal',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
'code': 'AN',
'display': 'Account number',
'userSelected': false
}
],
'text': 'Federated Person Principal'
},
'system': 'urn:oid:2.16.840.1.113883.3.13.6',
'value': 'URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:RS7MH9WX3XB8VY63',
'period': {
'start': '2020-08-10T14:29:20.000Z'
}
},
{
'id': 'CI-490059563-3',
'use': 'usual',
'type': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4',
'code': '2553236771',
'display': 'Federated Person Principal',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
'code': 'AN',
'display': 'Account number',
'userSelected': false
}
],
'text': 'Federated Person Principal'
},
'system': 'urn:oid:2.16.840.1.113883.3.13.6',
'value': 'URN:CERNER:IDENTITY-FEDERATION:REALM:E8A84236-C258-4952-98B7-A6FF8A9C587A-CH:PRINCIPAL:RS7MH9WX3XB8VY63',
'period': {
'start': '2020-06-30T20:06:42.000Z'
}
},
{
'id': 'CI-490153231-4',
'use': 'usual',
'type': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4',
'code': '2553236785',
'display': 'MIllennium Person Identifier',
'userSelected': true
}
],
'text': 'MIllennium Person Identifier'
},
'value': '12868',
'period': {
'start': '2020-12-18T19:15:06.000Z'
}
}
],
'active': true,
'patient': {
'reference': 'Patient/12724068',
'display': 'SMART, HAILEY'
},
'relationship': [
{
'id': 'CI-490017041-0',
'extension': [
{
'valuePeriod': {
'start': '2019-12-26T16:06:26.000Z'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/period'
},
{
'valueCodeableConcept': {
'coding': [
{
'system': 'https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40',
'code': '156',
'display': 'Mother',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'MTH',
'display': 'mother',
'userSelected': false
}
],
'text': 'Mother'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
}
],
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351',
'code': '1150',
'display': 'Default Guarantor',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'GT',
'display': 'Guarantor',
'userSelected': false
}
],
'text': 'Default Guarantor'
},
{
'id': 'CI-490017055-1',
'extension': [
{
'valuePeriod': {
'start': '2019-12-26T16:06:26.000Z'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/period'
},
{
'valueCodeableConcept': {
'coding': [
{
'system': 'https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40',
'code': '156',
'display': 'Mother',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'MTH',
'display': 'mother',
'userSelected': false
},
'text': 'Mother'
]
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
}
],
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351',
'code': '1153',
'display': 'Family Member',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'FAMMEMB',
'display': 'family member',
'userSelected': false
}
],
'text': 'Family Member'
}
],
'name': [
{
'id': 'CI-12724066-0',
'use': 'official',
'text': 'SMART, NANCY',
'family': 'SMART',
'given': [
'NANCY'
],
'period': {
'start': '2019-12-26T15:12:34.000Z'
}
}
],
'telecom': [
{
'id': 'CI-PH-29852801-0',
'extension': [
{
'valueUrl': '13215555555',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '13215555555',
'use': 'work',
'period': {
'start': '2021-03-22T14:12:37.000Z'
}
},
{
'id': 'CI-PH-29811918-1',
'extension': [
{
'valueUrl': '(987)654-3210',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '9876543210',
'use': 'home',
'period': {
'start': '2019-12-26T15:12:34.000Z'
}
},
{
'id': 'CI-PH-29844706-2',
'extension': [
{
'valueUrl': '(503)400-8675',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '5034008675',
'use': 'mobile',
'period': {
'start': '2021-01-25T05:00:00.000Z'
}
},
{
'id': 'CI-PH-29844710-3',
'extension': [
{
'valueUrl': '5034008675',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '5034008675',
'use': 'mobile',
'period': {
'start': '2021-01-25T05:00:00.000Z'
}
},
{
'id': 'CI-PH-29844690-4',
'extension': [
{
'valueUrl': '5034008675',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '5034008675',
'use': 'mobile',
'period': {
'start': '2021-01-25T05:00:00.000Z'
}
},
{
'id': 'CI-PH-29844708-5',
'extension': [
{
'valueUrl': '5034008675',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '5034008675',
'use': 'mobile',
'period': {
'start': '2021-01-25T05:00:00.000Z'
}
},
{
'id': 'CI-PH-29844688-6',
'extension': [
{
'valueUrl': '5034008675',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '5034008675',
'use': 'mobile',
'period': {
'start': '2021-01-25T00:33:18.000Z'
}
},
{
'id': 'CI-EM-29822894-0',
'system': 'email',
'value': 'workemail@gmail.com',
'use': 'home',
'period': {
'start': '2020-06-30T19:47:10.000Z'
}
}
],
'gender': 'female',
'birthDate': '1980-08-11',
'address': [
{
'id': 'CI-24313551-0',
'use': 'home',
'text': '3P\nKANSAS CITY, MO 641510001\nUS',
'line': [
'3P'
],
'city': 'KANSAS CITY',
'district': 'Jackson',
'state': 'MO',
'postalCode': '641510001',
'country': 'US',
'period': {
'start': '2020-12-08T15:05:44.000Z'
}
}
],
'communication': [
{
'language': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36',
'code': '151',
'display': 'English',
'userSelected': true
},
{
'system': 'urn:ietf:bcp:47',
'code': 'en',
'display': 'English',
'userSelected': false
}
],
'text': 'English'
},
'preferred': 'true'
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.
x-retrieve-encounter-level Response
Example retrieval of an encounter-level related person record.
Example Request:GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12457994-97697434
{
'resourceType': 'RelatedPerson',
'id': 'E-12457994-97697434',
'meta': {
'versionId': '21',
'lastUpdated': '2018-10-30T14:17:47.000Z'
},
'text': {
'status': 'extensions',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Related Person</b></p><p><b>Name</b>: MATERNITY, TESTTHREE</p><p><b>DOB</b>: Jun 20, 1987</p><p><b>Gender</b>: female</p><p><b>Patient</b>: NEWBORN, TESTTHREE</p><p><b>Status</b>: Active</p><p><b>Relationship</b>: Default Guarantor</p><p><b>Relationship</b>: Child</p><p><b>Relationship Level</b>: Encounter</p><p><b>Encounter</b>: 97697434</p></div>'
},
'extension': [
{
'valueReference': {
'reference': 'Encounter/97697434'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter'
},
{
'valueCodeableConcept': {
'coding': [
{
'system': 'http://hl7.org/fhir/resource-types',
'code': 'Encounter',
'display': 'Encounter'
}
],
'text': 'Encounter'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level'
}
],
'active': true,
'patient': {
'reference': 'Patient/12457995',
'display': 'NEWBORN, TESTTHREE'
},
'relationship': [
{
'id': 'CI-97982588-0',
'extension': [
{
'valuePeriod': {
'start': '2016-12-08T21:53:53.000Z'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/period'
},
{
'valueCodeableConcept': {
'coding': [
{
'system': 'https://fhir.cerner.com/2c400054-42d8-4e74-87b7-80b5bd5fde9f/codeSet/40',
'code': '156',
'display': 'Mother',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'MTH',
'display': 'mother',
'userSelected': false
}
],
'text': 'Mother'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
}
],
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351',
'code': '1150',
'display': 'Default Guarantor',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
'code': 'GT',
'display': 'Guarantor',
'userSelected': false
}
],
'text': 'Default Guarantor'
}
],
'name': [
{
'id': 'CI-12457994-0',
'use': 'official',
'text': 'MATERNITY, TESTTHREE',
'family': 'MATERNITY',
'given': [
'TESTTHREE'
],
'period': {
'start': '2016-12-08T21:28:22.000Z'
}
}
],
'telecom': [
{
'id': 'CI-PH-29583893-0',
'extension': [
{
'valueUrl': '426-475-8753',
'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
}
],
'system': 'phone',
'value': '4264758753',
'use': 'home',
'period': {
'start': '2016-12-08T21:28:22.000Z'
}
}
],
'gender': 'female',
'birthDate': '1987-06-20',
'address': [
{
'id': 'CI-24079465-0',
'use': 'home',
'text': "3343 Genessee St\nKansas City, MO 64111\nUS",
'line': [
'3343 Genessee St'
],
'city': 'Kansas City',
'state': 'MO',
'postalCode': '64111',
'country': 'US',
'period': {
'start': '2016-12-08T21:05:59.000Z'
}
}
],
'communication': [
{
'language': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36',
'code': '151',
'display': 'English',
'userSelected': true
},
{
'system': 'urn:ietf:bcp:47',
'code': 'en',
'display': 'English',
'userSelected': false
}
],
'text': 'English'
},
'preferred': 'true'
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.