Relatedperson Profile

This RelatedPerson profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read, search, create and update capabilities of these products.

Overview

This resource captures Information about a person that is involved in the care of a patient but who is not the target of healthcare nor has a formal responsibility in the care process.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access RelatedPerson resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

The profile also defines the content that must be supplied to the API Server in response to requests to populate RelatedPerson resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.

Source

The RelatedPerson resource is used to access and update patient related contacts (e.g., Family members). It is derived from the PatientRelationship, Guarantor and CareTeamMember tables in athenaFlow and the RELPERS and CARETEAMMEMBER tables in athenaFlow. Specific detail can be found in the Mappings section in the profile detail page.

Supported Operations

The operations supported by this resource are listed below.

Read Operation

Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a RelatedPerson, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.

GET [base]/fhir/RelatedPerson/[id]{?_format=[json|xml]&_summary=[true|data]}

Read Operation Parameters

ParameterDescription
[base]Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[id]Specifies the identifier of the RelatedPerson resource to retrieve
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary]Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times.

Read Operation HTTP Response Codes

Response CodeDescription
200 OKThe requested resource was found and is contained within the body of the HTTP response.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
404 Not FoundThe requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Search Operation

Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for RelatedPerson resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/RelatedPerson?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Search Operation Parameters

ParameterDescription
[base]Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_count]Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results RelatedPerson resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary]Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token )The ID of the resource
_security (token )
address-city (string )A city specified in an address
address-country (string )A country specified in an address
address-postalcode (string )A postal code specified in an address
address-state (string )A state specified in an address
birthdate (date )The Related Person's date of birth
birthdate-fromnow (quantity )Like birthdate except expressed as a positive or negative offset from the current time in units of time , e.g. birthdate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
gender (token )Gender of the person
identifier (token )A patient Identifier
patient (reference )The patient this person is related to
phone (token )A value in a phone contact
telecom (token )The value in any kind of contact

Search Operation HTTP Response Codes

Response CodeDescription
200 OKThe query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Create Operation

Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new RelatedPerson resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.

POST [base]/fhir/RelatedPerson?{_format=[json|xml]}

Create Operation Parameters

ParameterDescription
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.

Create Operation HTTP Response Codes

Response CodeDescription
201 CreatedThe resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes.
400 Bad RequestThe resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
422 Unprocessable EntityThe proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Update Operation

Update operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new RelatedPerson resource, an application must perform an HTTP PUT, specifying the content of the resource in the body of the request.

PUT [base]/fhir/RelatedPerson/[id]?{_format=[json|xml]}

Update Operation Parameters

ParameterDescription
[_format]Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.

Update Operation HTTP Response Codes

Response CodeDescription
200 OKThe resource was updated at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes.
400 Bad RequestThe resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure.
401 UnauthorizedAuthorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
422 Unprocessable EntityThe proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure.
500 Server ErrorThe server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/relatedperson-profile

An person that is related to a patient, but who is not a direct target of care

Name Flags Card. Type Description & Constraints
.. RelatedPerson0..*RelatedPerson An person that is related to a patient, but who is not a direct target of care
... meta∑0..1Meta Metadata about the resource
... implicitRules?! ∑0..1uri A set of rules under which this content was created
... language0..1code Language of the resource content

Binding: IETF BCP-47 (required )
... textI0..1Narrative Text summary of the resource, for human interpretation
... contained0..*Resource Contained, inline Resources
... extension0..*Extension Additional Content defined by implementations
... modifierExtension?!0..*Extension Extensions that cannot be ignored
... identifier∑Identifier A human identifier for this person

Slice: Unordered, Closed, by type
... identifier∑1..*Identifier A human identifier for this person
... identifier∑0..1Identifier A human identifier for this person
... identifier∑0..1Identifier A human identifier for this person
... patient∑1..1Reference (Patient )The patient this person is related to
... relationship∑0..1CodeableConcept The nature of the relationship

Binding: PatientRelationshipType (required )
... name∑1..1HumanName A name associated with the person
.... extension0..*Extension Additional Content defined by implementations
.... use?! ∑0..1code usual | official | temp | nickname | anonymous | old | maiden

Binding: NameUse (required )
.... text∑0..1string Text representation of the full name
.... family∑0..1string Family name (often called 'Surname')
.... given∑string Given names (not always 'first'). Includes middle names

Slice: Ordered, Closed, by given
.... given∑0..2string Given names (not always 'first'). Includes middle names
.... given∑0..1string Given names (not always 'first'). Includes middle names
.... given∑0..1string Given names (not always 'first'). Includes middle names
.... prefix∑0..1string Parts that come before the name
.... suffix∑0..1string Parts that come after the name
.... period∑0..1Period Time period when name was/is in use
... telecom∑ContactPoint A contact detail for the person

Slice: Unordered, Closed, by type use
... telecom∑0..6ContactPoint A contact detail for the person
... telecom∑0..1ContactPoint A contact detail for the person
.... extension0..*Extension Additional Content defined by implementations
.... system∑ I1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: phone
.... value∑1..1string The actual contact point details
.... use?! ∑0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )

Fixed Value: work
.... rank∑0..1positiveInt Specify preferred order of use (1 = highest)
.... period∑0..1Period Time period when the contact point was/is in use
... telecom∑0..1ContactPoint A contact detail for the person
.... extension0..*Extension Additional Content defined by implementations
.... system∑ I1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: phone
.... value∑1..1string The actual contact point details
.... use?! ∑0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )

Fixed Value: home
.... rank∑0..1positiveInt Specify preferred order of use (1 = highest)
.... period∑0..1Period Time period when the contact point was/is in use
... telecom∑0..1ContactPoint A contact detail for the person
.... extension0..*Extension Additional Content defined by implementations
.... system∑ I1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: phone
.... value∑1..1string The actual contact point details
.... use?! ∑0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )

Fixed Value: mobile
.... rank∑0..1positiveInt Specify preferred order of use (1 = highest)
.... period∑0..1Period Time period when the contact point was/is in use
... telecom∑0..1ContactPoint A contact detail for the person
.... extension0..*Extension Additional Content defined by implementations
.... system∑ I1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: fax
.... value∑1..1string The actual contact point details
.... rank∑0..1positiveInt Specify preferred order of use (1 = highest)
.... period∑0..1Period Time period when the contact point was/is in use
... telecom∑0..1ContactPoint A contact detail for the person
.... extension0..*Extension Additional Content defined by implementations
.... system∑ I1..1code phone | fax | email | pager | other

Binding: ContactPointSystem (required )

Fixed Value: pager
.... value∑1..1string The actual contact point details
.... use?! ∑0..1code home | work | temp | old | mobile - purpose of this contact point

Binding: ContactPointUse (required )
.... rank∑0..1positiveInt Specify preferred order of use (1 = highest)
.... period∑0..1Period Time period when the contact point was/is in use
... gender∑0..1code male | female | other | unknown

Binding: AdministrativeGender (required )
... birthDate∑0..1date The date on which the related person was born
... address∑0..1Address Address where the related person can be contacted or visited
.... extension0..*Extension Additional Content defined by implementations
.... use?! ∑0..1code home | work | temp | old - purpose of this address

Binding: AddressUse (required )

Example: home
.... type∑0..1code postal | physical | both

Binding: AddressType (required )

Example: both
.... text∑0..1string Text representation of the address

Example: 137 Nowhere Street, Erewhon 9132
.... line∑string Street name, number, direction & P.O. Box etc.

Slice: Ordered, Closed, by line

Example: 137 Nowhere Street
.... line∑0..2string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... line∑0..1string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... line∑0..1string Street name, number, direction & P.O. Box etc.

Example: 137 Nowhere Street
.... city∑0..1string Name of city, town etc.

Example: Erewhon
.... district∑0..1string District name (aka county)

Example: Madison
.... state∑0..1string Sub-unit of country (abbreviations ok)
.... postalCode∑0..1string Postal code for area

Example: 9132
.... country∑0..1string Country (can be ISO 3166 3 letter code)
.... period∑0..1Period Time period when address was/is in use

Example: {"start":"2010-03-23","end":"2010-07-01"}
... photo0..*Attachment Image of the person
... period0..1Period Period of time that this relationship is considered valid


 

athenaPractice Mapping

The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs. athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are the same. Use of this information is subject to the API Server Terms and Conditions .

Relatedperson Profile
RelatedPersonRelatedPerson-ProfileFHIR_RELATEDPERSONVIEW
 ├ idIDMakeIdWithPrefixAndSuffix(%ID%,%ID_PREFIX%,%PID%)
 ├ identifierRelated Person Identifiers
 ├ identifierSSNMakeIdentifier("secondary","http://hl7.org/fhir/identifier-type","SB","http://hl7.org/fhir/sid/us-ssn",%SSN%)
 ├ identifierExternalMakeIdentifierWithPrefixAndSuffix("U",getSiteSystem("RelatedPersonId"),%ID%,%ID_PREFIX%,%PID%)
 ├ patientPIDMakeReference("PATIENTPROFILE",%PID%,"Patient")
 ├ relationshipRELATIONSHIPMapConcept(%RELATIONSHIP%,"PATIENTRELATIONSHIP")
  │ ├ familyLASTNAME%LASTNAME%
  │ ├ givenGiven Names
  │ ├ givenFIRSTNAME%FIRSTNAME%
  │ ├ givenMIDDLENAME%MIDDLENAME%
  │ ├ prefixTITLE%TITLE%
  │ └ suffixENTITLEMENTS%ENTITLEMENTS%
 ├ telecomPhone Numbers
 ├ telecomWORKPHONE
  │ └ value%WORKPHONE%
 ├ telecomALTPHONE
  │ └ value%ALTPHONE%
 ├ telecomCELLPHONE
  │ └ value%CELLPHONE%
 ├ telecomFAXPHONE
  │ └ value%FAXPHONE%
 ├ telecomPAGERPHONE
  │ └ value%PAGERPHONE%
 ├ gendergenderMapCode(%SEX%,"GENDER")
 └ birthDateBIRTHDATE%BIRTHDATE%
   ├ lineAddress Lines
   ├ lineADDRESS1%ADDRESS1%
   ├ lineADDRESS2%ADDRESS2%
   ├ cityCITY%CITY%
   ├ stateSTATE%STATE%
   ├ postalCodeZIP%ZIP%
   └ countryCOUNTRY%COUNTRY%

athenaFlow Mapping

The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs. Use of this information is subject to the API Server Terms and Conditions .

Relatedperson Profile
RelatedPersonRelatedPerson-ProfileFHIR_RELATEDPERSONVIEW
 ├ idIDMakeId(%ID%)
 ├ identifierRelated Person Identifiers
 ├ identifierSSN
 ├ identifierExternalMakeIdentifier("U",getSiteSystem("RelatedPersonId"),%ID%)
 ├ patientPIDMakeReference("PERSON",%PID%,"Patient")
 ├ relationshipRELATIONSHIPMapConcept(%RELATIONSHIP%,"PATIENTRELATIONSHIP")
  │ ├ familyLASTNAME%LASTNAME%
  │ ├ givenGiven Names
  │ ├ givenFIRSTNAME%FIRSTNAME%
  │ ├ givenMIDDLENAME%MIDDLENAME%
  │ ├ prefixTITLE%TITLE%
  │ └ suffixENTITLEMENTS%ENTITLEMENTS%
 ├ telecomPhone Numbers
 ├ telecomWORKPHONE
  │ └ value%WORKPHONE%
 ├ telecomALTPHONE
  │ └ value%ALTPHONE%
 ├ telecomCELLPHONE
  │ └ value%CELLPHONE%
 ├ telecomFAXPHONE
  │ └ value%FAXPHONE%
 ├ telecomPAGERPHONE
  │ └ value%PAGERPHONE%
 ├ gendergenderMapCode(%SEX%,"GENDER")
 └ birthDateBIRTHDATE%BIRTHDATE%
   ├ lineAddress Lines
   ├ lineADDRESS1%ADDRESS1%
   ├ lineADDRESS2%ADDRESS2%
   ├ cityCITY%CITY%
   ├ stateSTATE%STATE%
   ├ postalCodeZIP%ZIP%
   └ countryCOUNTRY%COUNTRY%