Guía implementación interoperabilidad FHIR sectorial e intersectorial
0.10.1 - ci-build

Guía implementación interoperabilidad FHIR sectorial e intersectorial - Local Development build (v0.10.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCEU - Family Member History

Defining URL:https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileFamilyMemberHistoryHCEU
Version:0.10.1
Name:ProfileFamilyMemberHistoryHCEU
Title:HCEU - Family Member History
Status:Draft as of 2025-07-10 20:24:14-0500
Definition:

Recurso que permite registrar información del estado de salud de un familiar de un paciente

Publisher:minsait - An Indra Company. Secretaría de Salud de Bogotá,
Copyright:

Secretaría de Salud de Bogotá

Source Resource:XML / JSON / Turtle

La URL oficial para este perfil es: 

https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileFamilyMemberHistoryHCEU

Vistas formales para el perfil

Descripción de perfiles, diferenciales, resumenes y cómo deben ser las representaciones en XML y JSON.

Esta estructura se deriva de FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory FamilyMemberHistory
... Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 1..1 CodeableConcept Gender patient
URL: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-GenderIdentity
... Slices for identifier S 1..* Identifier External Id(s) for this record
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier External Id(s) for this record
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/FamilyMemberHistories/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... instantiatesCanonical 0..0
... status 1..1 code completed | partial
Example ej: partial
Example ej2: completed
... dataAbsentReason 0..0
... patient 1..1 Reference(HCEU - Patient) Patient history is about
... date 0..0
... name 0..0
... relationship 1..1 CodeableConcept Relationship to the subject
Example ej: {"coding":[{"system":"https://hl7.org/fhir/R4/v3/FamilyMember/vs.html","code":"BRO","display":"Brother"}]}
... sex 0..0
... deceased[x] 0..1 Age Dead? How old/when?
... reasonCode
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icd.who.int/browse/2024-01/mms/es
..... code 1..1 code Symbol in syntax defined by the system
.... text 1..1 string Plain text representation of the concept
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Allergy Intolerance | HCEU - Diagnostic Report) Why was family member history performed?
... note S 0..* Annotation General note about related person
... condition 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 1..1 CodeableConcept Gender patient
URL: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-GenderIdentity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External Id(s) for this record
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier Σ 1..1 Identifier External Id(s) for this record
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/FamilyMemberHistories/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code completed | partial
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
Example ej: partial
Example ej2: completed
... patient Σ 1..1 Reference(HCEU - Patient) Patient history is about
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
Example ej: {"coding":[{"system":"https://hl7.org/fhir/R4/v3/FamilyMember/vs.html","code":"BRO","display":"Brother"}]}
... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Age Dead? How old/when?
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://icd.who.int/browse/2024-01/mms/es
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 1..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Allergy Intolerance | HCEU - Diagnostic Report) Why was family member history performed?
... note S 0..* Annotation General note about related person

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... identifier Σ 1..* Identifier External Id(s) for this record
Slice: Unordered, Open by pattern:use
... note 0..* Annotation General note about related person

doco Documentation for this format

Vista de diferencias

Esta estructura se deriva de FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory FamilyMemberHistory
... Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 1..1 CodeableConcept Gender patient
URL: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-GenderIdentity
... Slices for identifier S 1..* Identifier External Id(s) for this record
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier External Id(s) for this record
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/FamilyMemberHistories/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... instantiatesCanonical 0..0
... status 1..1 code completed | partial
Example ej: partial
Example ej2: completed
... dataAbsentReason 0..0
... patient 1..1 Reference(HCEU - Patient) Patient history is about
... date 0..0
... name 0..0
... relationship 1..1 CodeableConcept Relationship to the subject
Example ej: {"coding":[{"system":"https://hl7.org/fhir/R4/v3/FamilyMember/vs.html","code":"BRO","display":"Brother"}]}
... sex 0..0
... deceased[x] 0..1 Age Dead? How old/when?
... reasonCode
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icd.who.int/browse/2024-01/mms/es
..... code 1..1 code Symbol in syntax defined by the system
.... text 1..1 string Plain text representation of the concept
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Allergy Intolerance | HCEU - Diagnostic Report) Why was family member history performed?
... note S 0..* Annotation General note about related person
... condition 0..0

doco Documentation for this format

Tabla de resumen

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..1 Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 1..1 CodeableConcept Gender patient
URL: https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-GenderIdentity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External Id(s) for this record
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier Σ 1..1 Identifier External Id(s) for this record
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/FamilyMemberHistories/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code completed | partial
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
Example ej: partial
Example ej2: completed
... patient Σ 1..1 Reference(HCEU - Patient) Patient history is about
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
Example ej: {"coding":[{"system":"https://hl7.org/fhir/R4/v3/FamilyMember/vs.html","code":"BRO","display":"Brother"}]}
... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Age Dead? How old/when?
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://icd.who.int/browse/2024-01/mms/es
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 1..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Allergy Intolerance | HCEU - Diagnostic Report) Why was family member history performed?
... note S 0..* Annotation General note about related person

doco Documentation for this format

 

Otras representaciones de este perfil: Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.identifier:HISdentifier.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
From the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf 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-4errorFamilyMemberHistoryIf 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-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
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()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()