Starter FHIR Implementation Guide
1.0.1 - draft International flag

Starter FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: Related Person Logical Model ( Experimental )

Official URL: http://jembi.org/fhir/StructureDefinition/RelatedPersonLogicalModel Version: 1.0.1
Active as of 2024-11-17 Computable Name: RelatedPersonLogicalModel

Exchange requirements example for the RelatedPerson Resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... name SΣ 1..* BackboneElement Name
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... relationshipType SΣ 1..1 CodeableConcept Relationship type
Binding: v3 Code System RoleCode (preferred)
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... name SΣ 1..* BackboneElement Name
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... relationshipType SΣ 1..1 CodeableConcept Relationship type
Binding: v3 Code System RoleCode (preferred)
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name SΣ 1..* BackboneElement Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... name SΣ 1..* BackboneElement Name
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... relationshipType SΣ 1..1 CodeableConcept Relationship type
Binding: v3 Code System RoleCode (preferred)
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... name SΣ 1..* BackboneElement Name
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... relationshipType SΣ 1..1 CodeableConcept Relationship type
Binding: v3 Code System RoleCode (preferred)
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPersonLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Related Person Logical Model
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name SΣ 1..* BackboneElement Name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... firstName 1..1 string First name
.... middleName 0..1 string Middle name
... maritalStatus SΣ 0..1 BackboneElement Marital status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 CodeableConcept Status
Binding: Marital Status Codes (extensible)
.... effectiveDate 1..1 date Effective date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPersonLogicalModel.relationshipTypepreferredRoleCode
http://terminology.hl7.org/ValueSet/v3-RoleCode
RelatedPersonLogicalModel.maritalStatus.statusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel