Standard Health Record FHIR Implementation Guide

SHR RelatedPerson Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-RelatedPerson

A person in a role defined in relationship to a patient

This profile builds on RelatedPerson.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.RelatedPerson maps to RelatedPerson:
  Person.ActiveFlag maps to active
  Person.HumanName maps to name
  Person.DateOfBirth maps to birthDate
  Person.AdministrativeGender maps to gender
  Person.Address maps to address
  Person.Headshot maps to photo
  Person.ContactPoint maps to telecom
  RelationshipType maps to relationship
  EffectiveTimePeriod maps to period

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*SHR RelatedPerson Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-entity-Person-extension 1..1Reference(SHR Person Profile)SHR Person Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Person-extension
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(Patient)The patient this person is related to
... relationship Σ0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (extensible)
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.RelatedPerson maps to RelatedPerson:
  Person.ActiveFlag maps to active
  Person.HumanName maps to name
  Person.DateOfBirth maps to birthDate
  Person.AdministrativeGender maps to gender
  Person.Address maps to address
  Person.Headshot maps to photo
  Person.ContactPoint maps to telecom
  RelationshipType maps to relationship
  EffectiveTimePeriod maps to period

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*SHR RelatedPerson Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-entity-Person-extension 1..1Reference(SHR Person Profile)SHR Person Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Person-extension
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(Patient)The patient this person is related to
... relationship Σ0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (extensible)
... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
RelatedPerson.languageCommon LanguagesextensibleCommon Languages
RelatedPerson.relationshipPatientRelationshipTypeextensiblePatientRelationshipType
RelatedPerson.genderAdministrativeGenderrequiredAdministrativeGender

 

Constraints

IdPathDetailsRequirements
dom-2RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4RelatedPersonIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3RelatedPersonIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()