MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/us/mcc/StructureDefinition/FamilyHistoryofCKD |
| Version: | 0.1.0 |
| Name: | FamilyHistoryofCKD |
| Title: | Family Member History of Chronic Kidney Disease |
| Status: | Active as of 2020-11-02T17:51:13+00:00 |
| Definition: | This profile constrains the FHIR Family Member History Resource to chronic kidney disease conditions. |
| Publisher: | HL7 International - Patient Care WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/mcc/StructureDefinition/FamilyHistoryofCKD
This profile sets additional expectations for the FHIR Family Member History Resource to record, search, and fetch first degree family members who have or had chronic kidney disease (CKD) conditions. FamilyMemberHistory.condition is set to “Must Support” and FamilyMemberHistory.condition.code is bound to a chronic kidney disease value set. FamilyMemberHistory.relationship is bound to a first degree family member value set which is a subset of the V3 Family Member Value set.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FamilyMemberHistory
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  FamilyMemberHistory | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:resource-pertainsToGoal | S | 0..* | Extension | Extension Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
 relationship | 1..1 | CodeableConcept | First Degree Family Member Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1032.92/expansion/Latest (preferred) | |
 condition | S | 0..* | BackboneElement | Condition that the related person had |
  code | S | 1..1 | CodeableConcept | Chronic Kidney Disease All Stages (1 through 5) Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion (required) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
 id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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:resource-pertainsToGoal | S | 0..* | Extension | Extension Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Id(s) for this record |
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
| dataAbsentReason | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example) |
 patient | Σ | 1..1 | Reference(Patient) | Patient history is about |
| date | Σ | 0..1 | dateTime | When history was recorded or last updated |
| name | Σ | 0..1 | string | The family member described |
| relationship | Σ | 1..1 | CodeableConcept | First Degree Family Member Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1032.92/expansion/Latest (preferred) |
| sex | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible) |
  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: SNOMEDCTClinicalFindings (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
| note | 0..* | Annotation | General note about related person | |
| condition | S | 0..* | BackboneElement | Condition that the related person had |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Chronic Kidney Disease All Stages (1 through 5) Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion (required) |
| outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example) | |
| contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |
| onset[x] | 0..1 | When condition first manifested | ||
| onsetAge | Age | |||
| onsetRange | Range | |||
| onsetPeriod | Period | |||
| onsetString | string | |||
| note | 0..* | Annotation | Extra information about condition | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
| extension:resource-pertainsToGoal | 0..* | Extension | Extension Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | |
| condition | 0..* | BackboneElement | Condition that the related person had | |
| code | 1..1 | CodeableConcept | Chronic Kidney Disease All Stages (1 through 5) Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion (required) | |
| Documentation for this format | ||||
This structure is derived from FamilyMemberHistory
Differential View
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-pertainsToGoal | S | 0..* | Extension | Extension Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| relationship | 1..1 | CodeableConcept | First Degree Family Member Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1032.92/expansion/Latest (preferred) | |
| condition | S | 0..* | BackboneElement | Condition that the related person had |
| code | S | 1..1 | CodeableConcept | Chronic Kidney Disease All Stages (1 through 5) Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion (required) |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
| id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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:resource-pertainsToGoal | S | 0..* | Extension | Extension Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Id(s) for this record |
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
| status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
| dataAbsentReason | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example) |
| patient | Σ | 1..1 | Reference(Patient) | Patient history is about |
| date | Σ | 0..1 | dateTime | When history was recorded or last updated |
| name | Σ | 0..1 | string | The family member described |
| relationship | Σ | 1..1 | CodeableConcept | First Degree Family Member Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1032.92/expansion/Latest (preferred) |
| sex | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible) |
| 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: SNOMEDCTClinicalFindings (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
| note | 0..* | Annotation | General note about related person | |
| condition | S | 0..* | BackboneElement | Condition that the related person had |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Chronic Kidney Disease All Stages (1 through 5) Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion (required) |
| outcome | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example) | |
| contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |
| onset[x] | 0..1 | When condition first manifested | ||
| onsetAge | Age | |||
| onsetRange | Range | |||
| onsetPeriod | Period | |||
| onsetString | string | |||
| note | 0..* | Annotation | Extra information about condition | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| FamilyMemberHistory.language | preferred | CommonLanguages Max Binding: AllLanguages |
| FamilyMemberHistory.status | required | FamilyHistoryStatus |
| FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReason |
| FamilyMemberHistory.relationship | preferred | https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1032.92/expansion/Latest |
| FamilyMemberHistory.sex | extensible | AdministrativeGender |
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings |
| FamilyMemberHistory.condition.code | required | https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.159/expansion |
| FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodes |
| 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-3 | FamilyMemberHistory | 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 | 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-5 | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
| fhs-1 | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
| fhs-2 | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() | |
| ele-1 | FamilyMemberHistory.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.extension:resource-pertainsToGoal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.extension:resource-pertainsToGoal | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.sex | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.born[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.age[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.estimatedAge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.outcome | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.contributedToDeath | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.mcc#0.1.0 based on FHIR 4.0.1. Generated 2020-11-02
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change