INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-FamilyMemberHistory-1
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FamilyMemberHistory
Summary
Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
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 |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-CareConnect-Recorder-1 | I | 0..1 | Reference() | Who recorded the event URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Recorder-1 |
encounter-associatedEncounter | I | 0..1 | Reference(Encounter) | Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Id(s) for this record |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
definition | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Instantiates protocol or definition |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
notDone | ?!Σ | 0..1 | boolean | The taking of a family member's history did not occur |
notDoneReason | ΣI | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryNotDoneReason (example) |
patient | Σ | 1..1 | Reference(CareConnect-Patient-1) | Patient history is about |
date | Σ | 0..1 | dateTime | When history was captured/updated |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | ΣI | 0..1 | (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
estimatedAge | ?!ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
reasonCode | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMED CT Clinical Findings (example) |
reasonReference | Σ | 0..* | Reference(QuestionnaireResponse | CareConnect-Observation-1 | CareConnect-Condition-1 | CareConnect-AllergyIntolerance-1) | Why was family member history performed? |
note | 0..* | Annotation | General note about related person | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
condition | I | 0..* | BackboneElement | Condition that the related person had |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/Diagnosis Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: Condition Outcome Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..* | Annotation | Extra information about condition | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
This structure is derived from FamilyMemberHistory
Summary
Mandatory: 0 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from FamilyMemberHistory
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
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 |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-CareConnect-Recorder-1 | I | 0..1 | Reference() | Who recorded the event URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Recorder-1 |
encounter-associatedEncounter | I | 0..1 | Reference(Encounter) | Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Id(s) for this record |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
definition | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Instantiates protocol or definition |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
notDone | ?!Σ | 0..1 | boolean | The taking of a family member's history did not occur |
notDoneReason | ΣI | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryNotDoneReason (example) |
patient | Σ | 1..1 | Reference(CareConnect-Patient-1) | Patient history is about |
date | Σ | 0..1 | dateTime | When history was captured/updated |
name | Σ | 0..1 | string | The family member described |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
born[x] | I | 0..1 | (approximate) date of birth | |
bornPeriod | Period | |||
bornDate | date | |||
bornString | string | |||
age[x] | ΣI | 0..1 | (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
estimatedAge | ?!ΣI | 0..1 | boolean | Age is estimated? |
deceased[x] | Σ | 0..1 | Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
reasonCode | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMED CT Clinical Findings (example) |
reasonReference | Σ | 0..* | Reference(QuestionnaireResponse | CareConnect-Observation-1 | CareConnect-Condition-1 | CareConnect-AllergyIntolerance-1) | Why was family member history performed? |
note | 0..* | Annotation | General note about related person | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
condition | I | 0..* | BackboneElement | Condition that the related person had |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/Diagnosis Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: Condition Outcome Codes (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedCT | Σ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
note | 0..* | Annotation | Extra information about condition | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorString | string | |||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
FamilyMemberHistory.language | extensible | Common Languages Max Binding: All Languages |
FamilyMemberHistory.identifier.use | required | IdentifierUse |
FamilyMemberHistory.identifier.type | extensible | Identifier Type Codes |
FamilyMemberHistory.status | required | FamilyHistoryStatus |
FamilyMemberHistory.notDoneReason | example | FamilyHistoryNotDoneReason |
FamilyMemberHistory.relationship | example | FamilyMember |
FamilyMemberHistory.gender | required | Administrative Gender |
FamilyMemberHistory.reasonCode | example | SNOMED CT Clinical Findings |
FamilyMemberHistory.condition.code | example | Condition/Problem/Diagnosis Codes |
FamilyMemberHistory.condition.outcome | example | Condition Outcome Codes |
Id | Path | Details | Requirements |
dom-2 | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | FamilyMemberHistory | 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-3 | FamilyMemberHistory | If 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() | |
fhs-2 | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() | |
fhs-3 | FamilyMemberHistory | Not Done Reason can only be specified if NotDone is "true" : notDone or notDoneReason.exists().not() | |
fhs-1 | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
ele-1 | FamilyMemberHistory.extension:recorder | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.extension:recorder | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.extension:encounter | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | FamilyMemberHistory.extension:encounter | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | FamilyMemberHistory.condition | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |