NCPI FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: NCPI Family Relationship

Official URL: https://ncpi-fhir.github.io/ncpi-fhir-ig/StructureDefinition/family-relationship				Version: 0.1.0
Draft as of 2022-08-16				Computable Name: FamilyRelationship

Representation of a family relationship.

Usage:

• Examples for this Resource Profile: Observation/family-relationship-example-1, Observation/family-relationship-example-2, Observation/family-relationship-example-3, Observation/family-relationship-example-4

Formal Views of Profile Content

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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Observation.language	preferred	CommonLanguages Max Binding: AllLanguages
Observation.status	required	ObservationStatus
Observation.category	preferred	ObservationCategoryCodes
Observation.code	example	Pattern: FAMMEMB("family member")
Observation.value[x]:valueCodeableConcept	extensible	FamilyMember
Observation.dataAbsentReason	extensible	DataAbsentReason
Observation.interpretation	extensible	ObservationInterpretationCodes
Observation.bodySite	example	SNOMEDCTBodyStructures
Observation.method	example	ObservationMethods
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes
Observation.component.code	example	LOINCCodes
Observation.component.dataAbsentReason	extensible	DataAbsentReason
Observation.component.interpretation	extensible	ObservationInterpretationCodes

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If 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-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
ele-1	error	Observation.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.code.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.code.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.code.coding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.code.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.focus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.effective[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.issued	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.value[x]:valueCodeableConcept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.bodySite	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.specimen	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.device	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
ele-1	error	Observation.referenceRange.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.referenceRange.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.referenceRange.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.referenceRange.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.referenceRange.low	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.high	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.appliesTo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.age	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.hasMember	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.derivedFrom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.component.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.component.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.component.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.component.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())