Standard Health Record FHIR Implementation Guide

SHR RelationshipType Profile

 

The official URL for this profile is:

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

The relationship of the subject to another person in the same extended family or extended family. May or may not be a blood relative.

This profile builds on Basic.

This profile was published on Tue Feb 27 00:00:00 EST 2018 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.RelationshipType maps to Basic:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR RelationshipType Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-entity-RelationshipType"}]}
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... valueCodeableConcept Binding: PatientRelationshipType (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR RelationshipType 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-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: PatientRelationshipType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-entity-RelationshipType"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

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.RelationshipType maps to Basic:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR RelationshipType Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-entity-RelationshipType"}]}
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... valueCodeableConcept Binding: PatientRelationshipType (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR RelationshipType 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-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: PatientRelationshipType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-entity-RelationshipType"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.extension.valueCodeableConceptPatientRelationshipTypeextensiblePatientRelationshipType
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf 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-3BasicIf 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()