US Core Implementation Guide
8.0.0 - STU 8 United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core RelatedPerson Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson Version: 8.0.0
Standards status: Trial-use Computable Name: USCoreRelatedPersonProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.57

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core RelatedPerson Profile inherits from the FHIR RelatedPerson resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the RelatedPerson resource to record, search, and fetch basic administrative information about persons with a legal or familial relationship to a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a related person that supports the patient.
  • Query for a person related to the patient by name.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each RelatedPerson Must Have:

  1. an active flag
  2. a patient

Each RelatedPerson Must Support:

  1. the relationship to the patient
  2. the name of the related person
  3. the telecom of the related person
  4. the address of the related person*

*see guidance below

Profile Specific Implementation Guidance:

Usage:

Changes since version 7.0.0:

  • No changes

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    us-core-14: Either a name or a relationship SHALL be provided (or both)
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
    ele-1: All FHIR elements must have a @value or children
    ... patient SΣ 1..1 Reference(US Core Patient Profile) The patient this person is related to
    ele-1: All FHIR elements must have a @value or children
    ... relationship SΣC 0..* CodeableConcept The nature of the relationship
    Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


    ele-1: All FHIR elements must have a @value or children
    ... name SΣC 0..* HumanName A name associated with the person
    ele-1: All FHIR elements must have a @value or children
    ... telecom SΣ 0..* ContactPoint A contact detail for the person
    ele-1: All FHIR elements must have a @value or children
    ... address SΣ 0..* Address Address where the related person can be contacted or visited
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    RelatedPerson.relationshippreferredPatientRelationshipType
    http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-14errorRelatedPersonEither a name or a relationship SHALL be provided (or both)
    : name.exists() or relationship.exists()

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Quick Start

    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to related person data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support both read RelatedPerson by id AND RelatedPerson search using the _id search parameter:

      GET [base]/RelatedPerson/[id] or GET [base]/RelatedPerson?_id=[id]

      Example:

      1. GET [base]/RelatedPerson/shaw-niece
      2. GET [base]/RelatedPerson?_id=shaw-niece

      Implementation Notes: (how to search by the logical id of the resource)

    Optional Search Parameters:

    The following search parameter combinations SHOULD be supported:

    1. SHOULD support searching for all relatedpersons for a patient using the patient search parameter:

      GET [base]/RelatedPerson?patient={Type/}[id]

      Example:

      1. GET [base]/RelatedPerson?patient=1032702

      Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient (how to search by reference)

    2. SHOULD support searching using the combination of the patient and name search parameters:

      GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]

      Example:

      1. GET [base]/RelatedPerson?patient=1137192&name=van%20Putten

      Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient that may match any of the string fields in the name element (including family, give, prefix, suffix, suffix, and/or text) (how to search by reference and how to search by string)