Visit the HL7 website
Visit the FHIR website

Pan-Canadian Patient Summary (PS-CA) v2.1.0 DFT

2.1.0-DFT   Canada flag
  • Index
  • Home
  • Business Context
    • Use Cases
    • Requirements
    • Privacy and Security Guidance
    • Relationship to Other Specifications
  • Technical Context
    • Overview
    • Sequence Diagrams
    • Core Interoperability Specification Requirements
    • Conformance and Specification Guidance
    • General Principles & Design
  • FHIR Artifacts
    • FHIR Artifacts
    • PS-CA Library of Profiles
    • Bundle (PS-CA)
    • Composition (PS-CA)
    • Patient (PS-CA)
    • Medication (PS-CA)
    • MedicationRequest (PS-CA)
    • MedicationStatement (PS-CA)
    • AllergyIntolerance (PS-CA)
    • Condition (PS-CA)
    • Procedure (PS-CA)
    • Immunization (PS-CA)
    • DiagnosticReport (PS-CA)
    • ImagingStudy (PS-CA)
    • Organization-Lab (PS-CA)
    • Practitioner-Lab (PS-CA)
    • PractitionerRole-Lab (PS-CA)
    • Observation Laboratory/Pathology (PS-CA)
    • Observation Radiology (PS-CA)
    • Observation Social History (PS-CA)
    • Observation Alcohol Use (PS-CA)
    • Observation Tobacco Use (PS-CA)
    • Family Member History (PS-CA)
    • Data Type Profiles
    • Extensions
    • Examples
    • Terminology
    • Downloads
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Family Member History (PS-CA)

DFT - For a full list of available versions, see the Directory of published versions

Family Member History (PS-CA)

Links

Profile

familymemberhistory-ca-ps

Derived from

http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory

Examples

Description

This profile represents the constraints applied to the FamilyMemberHistory resource by the PS-CA project. Currently, there is no equivalent IPS UV profile and no ISO CEN IPS 17269 requirements for a family history section. This profile is considered a draft version, and is informed and created as per the requirements of the first jurisdiction (i.e. Alberta) to pilot its use in patient summary within jurisdictional context. The constraints have been compared against other Family Member History FHIR profiles in Canada (OMD Core Data Set, Telus Patient Chart) and Internationally (Swiss Mednet, CareConnect UK, NDHM India) and share many constraints in common with those profiles but represent the minimum requirements as they are known in Canada today. This profile is expected to be refined further as more jurisdictional requirements are defined and as more is known about use in the international patient summary space.

References to this resource

CompositionPSCA

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
FamilyMemberHistoryPSCA (FamilyMemberHistory)CFamilyMemberHistory
There are no (further) constraints on this element
Element id
FamilyMemberHistory
Short description

Information about patient's relatives, relevant for patient

Definition

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Data type

FamilyMemberHistory

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • fhs-1: Can have age[x] or born[x], but not both
    age.empty() or born.empty()
  • fhs-2: Can only have estimatedAge if age[x] is present
    age.exists() or estimatedAge.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: Not in scope for v2
  • rim: Observation[classCode=OBS, moodCode=EVN]
idΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
FamilyMemberHistory.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
FamilyMemberHistory.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
FamilyMemberHistory.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
FamilyMemberHistory.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
FamilyMemberHistory.identifier
Short description

External Id(s) for this record

Definition

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: id
instantiatesCanonicalΣ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
There are no (further) constraints on this element
Element id
FamilyMemberHistory.instantiatesCanonical
Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Data type

canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.instantiatesCanonical
  • rim: .outboundRelationship[typeCode=DEFN].target
instantiatesUriΣ0..*uri
There are no (further) constraints on this element
Element id
FamilyMemberHistory.instantiatesUri
Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.instantiatesUri
  • rim: .outboundRelationship[typeCode=DEFN].target
statusS Σ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.status
Short description

partial | completed | entered-in-error | health-unknown

Definition

A code specifying the status of the record of the family history of a specific family member.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

code

Binding

A code that identifies the status of the family history record.

FamilyHistoryStatus (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
dataAbsentReasonΣ0..1CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.dataAbsentReason
Short description

subject-unknown | withheld | unable-to-obtain | deferred

Definition

Describes why the family member's history is not available.

Requirements

This is a separate element to allow it to have a distinct binding from reasonCode.

Data type

CodeableConcept

Binding

Codes describing the reason why a family member's history is not available.

FamilyHistoryAbsentReason (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .reasonCode
patientS Σ1..1Reference(PatientPSCA)Element id
FamilyMemberHistory.patient
Short description

Patient history is about

Alternate names

Proband

Definition

The person who this history concerns.

Data type

Reference(PatientPSCA)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • rim: participation[typeCode=SBJ].role
  • w5: FiveWs.subject
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
referenceS Σ C1..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.type
Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.identifier
Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
displayΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.display
Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
dateΣ0..1dateTimeElement id
FamilyMemberHistory.date
Short description

When history was recorded or last updated

Definition

The date (and possibly time) when the family member history was recorded or last updated.

Requirements

Allows determination of how current the summary is.

Comments

This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.

Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • rim: participation[typeCode=AUT].time
nameΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.name
Short description

The family member described

Definition

This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

Requirements

Allows greater ease in ensuring the same person is being talked about.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: name
relationshipS Σ1..1CodeableConceptPSCAElement id
FamilyMemberHistory.relationship
Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.

Data type

CodeableConceptPSCA

Binding

The nature of the relationship between the patient and the related person being described in the family member history.

v3.FamilyMember (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: code
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sexΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.sex
Short description

male | female | other | unknown

Definition

The birth sex of the family member.

Requirements

Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.

Comments

This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.

Data type

CodeableConcept

Binding

Codes describing the sex assigned at birth as documented on the birth registration.

AdministrativeGender (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
born[x]C0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.born[x]
Short description

(approximate) date of birth

Definition

The actual or approximate date of birth of the relative.

Requirements

Allows calculation of the relative's age.

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
bornPeriodPeriod
There are no (further) constraints on this element
Data type

Period

bornDatedate
There are no (further) constraints on this element
Data type

date

bornStringstring
There are no (further) constraints on this element
Data type

string

age[x]Σ C0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.age[x]
Short description

(approximate) age

Definition

The age of the relative at the time the family member history is recorded.

Requirements

While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.

Comments

use estimatedAge to indicate whether the age is actual or not.

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
ageAgeAge
There are no (further) constraints on this element
Data type

Age

ageRangeRange
There are no (further) constraints on this element
Data type

Range

ageStringstring
There are no (further) constraints on this element
Data type

string

estimatedAgeΣ C0..1boolean
There are no (further) constraints on this element
Element id
FamilyMemberHistory.estimatedAge
Short description

Age is estimated?

Definition

If true, indicates that the age value specified is an estimated value.

Requirements

Clinicians often prefer to specify an estimaged age rather than an age range.

Comments

This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.

Meaning when missing

It is unknown whether the age is an estimate or not

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
deceased[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.deceased[x]
Short description

Dead? How old/when?

Definition

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
deceasedBooleanboolean
There are no (further) constraints on this element
Data type

boolean

deceasedAgeAge
There are no (further) constraints on this element
Data type

Age

deceasedRangeRange
There are no (further) constraints on this element
Data type

Range

deceasedDatedate
There are no (further) constraints on this element
Data type

date

deceasedStringstring
There are no (further) constraints on this element
Data type

string

reasonCodeΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.reasonCode
Short description

Why was family member history performed?

Definition

Describes why the family member history occurred in coded or textual form.

Comments

Textual reasons can be captured using reasonCode.text.

Data type

CodeableConcept

Binding

Codes indicating why the family member history was done.

SNOMEDCTClinicalFindings (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.reasonCode
  • w5: FiveWs.why[x]
  • rim: .reasonCode
reasonReferenceΣ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
There are no (further) constraints on this element
Element id
FamilyMemberHistory.reasonReference
Short description

Why was family member history performed?

Definition

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

Data type

Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.reasonReference
  • w5: FiveWs.why[x]
  • rim: .outboundRelationship[typeCode=RSON].target
noteS0..*Annotation
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note
Short description

General note about related person

Definition

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.note
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
author[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.author[x]
Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
authorStringstring
There are no (further) constraints on this element
Data type

string

authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
There are no (further) constraints on this element
Data type

Reference(Practitioner | Patient | RelatedPerson | Organization)

timeΣ0..1dateTime
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.time
Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
textS Σ1..1markdownElement id
FamilyMemberHistory.note.text
Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Comments

Family_History_Notes

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
condition0..*BackboneElementElement id
FamilyMemberHistory.condition
Short description

Condition that the related person had

Definition

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Comments

This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .

Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
code1..1CodeableConceptPSCAElement id
FamilyMemberHistory.condition.code
Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.

Data type

CodeableConceptPSCA

Binding

Identification of the Condition or diagnosis.

Condition/Problem/DiagnosisCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .value
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
outcome0..1CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.outcome
Short description

deceased | permanent disability | etc.

Definition

Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

Data type

CodeableConcept

Binding

The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

ConditionOutcomeCodes (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
contributedToDeath0..1boolean
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.contributedToDeath
Short description

Whether the condition contributed to the cause of death

Definition

This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
onset[x]0..1Element id
FamilyMemberHistory.condition.onset[x]
Short description

When condition first manifested

Definition

Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

Requirements

Age of onset of a condition in relatives is predictive of risk for the patient.

Comments

The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string
onsetAgeAge
There are no (further) constraints on this element
Data type

Age

onsetRangeRange
There are no (further) constraints on this element
Data type

Range

onsetPeriodPeriod
There are no (further) constraints on this element
Data type

Period

onsetStringstring
There are no (further) constraints on this element
Data type

string

note0..*Annotation
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note
Short description

Extra information about condition

Definition

An area where general notes can be placed about this specific condition.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
author[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.author[x]
Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
authorStringstring
There are no (further) constraints on this element
Data type

string

authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
There are no (further) constraints on this element
Data type

Reference(Practitioner | Patient | RelatedPerson | Organization)

timeΣ0..1dateTime
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.time
Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
textS Σ1..1markdown
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.text
Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
FamilyMemberHistoryPSCA (FamilyMemberHistory)CFamilyMemberHistory
There are no (further) constraints on this element
Element id
FamilyMemberHistory
Short description

Information about patient's relatives, relevant for patient

Definition

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Data type

FamilyMemberHistory

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • fhs-1: Can have age[x] or born[x], but not both
    age.empty() or born.empty()
  • fhs-2: Can only have estimatedAge if age[x] is present
    age.exists() or estimatedAge.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: Not in scope for v2
  • rim: Observation[classCode=OBS, moodCode=EVN]
idΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
FamilyMemberHistory.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
FamilyMemberHistory.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
FamilyMemberHistory.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
FamilyMemberHistory.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
FamilyMemberHistory.identifier
Short description

External Id(s) for this record

Definition

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: id
instantiatesCanonicalΣ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
There are no (further) constraints on this element
Element id
FamilyMemberHistory.instantiatesCanonical
Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Data type

canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.instantiatesCanonical
  • rim: .outboundRelationship[typeCode=DEFN].target
instantiatesUriΣ0..*uri
There are no (further) constraints on this element
Element id
FamilyMemberHistory.instantiatesUri
Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.instantiatesUri
  • rim: .outboundRelationship[typeCode=DEFN].target
statusS Σ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.status
Short description

partial | completed | entered-in-error | health-unknown

Definition

A code specifying the status of the record of the family history of a specific family member.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

code

Binding

A code that identifies the status of the family history record.

FamilyHistoryStatus (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
dataAbsentReasonΣ0..1CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.dataAbsentReason
Short description

subject-unknown | withheld | unable-to-obtain | deferred

Definition

Describes why the family member's history is not available.

Requirements

This is a separate element to allow it to have a distinct binding from reasonCode.

Data type

CodeableConcept

Binding

Codes describing the reason why a family member's history is not available.

FamilyHistoryAbsentReason (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .reasonCode
patientS Σ1..1Reference(PatientPSCA)
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient
Short description

Patient history is about

Alternate names

Proband

Definition

The person who this history concerns.

Data type

Reference(PatientPSCA)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • rim: participation[typeCode=SBJ].role
  • w5: FiveWs.subject
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
referenceS Σ C1..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.type
Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.identifier
Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
displayΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.patient.display
Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
dateΣ0..1dateTime
There are no (further) constraints on this element
Element id
FamilyMemberHistory.date
Short description

When history was recorded or last updated

Definition

The date (and possibly time) when the family member history was recorded or last updated.

Requirements

Allows determination of how current the summary is.

Comments

This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.

Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • rim: participation[typeCode=AUT].time
nameΣ0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.name
Short description

The family member described

Definition

This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

Requirements

Allows greater ease in ensuring the same person is being talked about.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: name
relationshipS Σ1..1CodeableConceptPSCA
There are no (further) constraints on this element
Element id
FamilyMemberHistory.relationship
Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.

Data type

CodeableConceptPSCA

Binding

The nature of the relationship between the patient and the related person being described in the family member history.

v3.FamilyMember (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: code
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sexΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
FamilyMemberHistory.sex
Short description

male | female | other | unknown

Definition

The birth sex of the family member.

Requirements

Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.

Comments

This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.

Data type

CodeableConcept

Binding

Codes describing the sex assigned at birth as documented on the birth registration.

AdministrativeGender (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
born[x]C0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.born[x]
Short description

(approximate) date of birth

Definition

The actual or approximate date of birth of the relative.

Requirements

Allows calculation of the relative's age.

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
bornPeriodPeriod
There are no (further) constraints on this element
Data type

Period

bornDatedate
There are no (further) constraints on this element
Data type

date

bornStringstring
There are no (further) constraints on this element
Data type

string

age[x]Σ C0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.age[x]
Short description

(approximate) age

Definition

The age of the relative at the time the family member history is recorded.

Requirements

While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.

Comments

use estimatedAge to indicate whether the age is actual or not.

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
ageAgeAge
There are no (further) constraints on this element
Data type

Age

ageRangeRange
There are no (further) constraints on this element
Data type

Range

ageStringstring
There are no (further) constraints on this element
Data type

string

estimatedAgeΣ C0..1boolean
There are no (further) constraints on this element
Element id
FamilyMemberHistory.estimatedAge
Short description

Age is estimated?

Definition

If true, indicates that the age value specified is an estimated value.

Requirements

Clinicians often prefer to specify an estimaged age rather than an age range.

Comments

This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.

Meaning when missing

It is unknown whether the age is an estimate or not

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: fhs-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
deceased[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.deceased[x]
Short description

Dead? How old/when?

Definition

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
deceasedBooleanboolean
There are no (further) constraints on this element
Data type

boolean

deceasedAgeAge
There are no (further) constraints on this element
Data type

Age

deceasedRangeRange
There are no (further) constraints on this element
Data type

Range

deceasedDatedate
There are no (further) constraints on this element
Data type

date

deceasedStringstring
There are no (further) constraints on this element
Data type

string

reasonCodeΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.reasonCode
Short description

Why was family member history performed?

Definition

Describes why the family member history occurred in coded or textual form.

Comments

Textual reasons can be captured using reasonCode.text.

Data type

CodeableConcept

Binding

Codes indicating why the family member history was done.

SNOMEDCTClinicalFindings (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.reasonCode
  • w5: FiveWs.why[x]
  • rim: .reasonCode
reasonReferenceΣ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
There are no (further) constraints on this element
Element id
FamilyMemberHistory.reasonReference
Short description

Why was family member history performed?

Definition

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

Data type

Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.reasonReference
  • w5: FiveWs.why[x]
  • rim: .outboundRelationship[typeCode=RSON].target
noteS0..*Annotation
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note
Short description

General note about related person

Definition

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.note
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
author[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.author[x]
Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
authorStringstring
There are no (further) constraints on this element
Data type

string

authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
There are no (further) constraints on this element
Data type

Reference(Practitioner | Patient | RelatedPerson | Organization)

timeΣ0..1dateTime
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.time
Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
textS Σ1..1markdown
There are no (further) constraints on this element
Element id
FamilyMemberHistory.note.text
Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Comments

Family_History_Notes

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
condition0..*BackboneElement
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition
Short description

Condition that the related person had

Definition

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Comments

This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .

Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
code1..1CodeableConceptPSCA
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.code
Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.

Data type

CodeableConceptPSCA

Binding

Identification of the Condition or diagnosis.

Condition/Problem/DiagnosisCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .value
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
outcome0..1CodeableConcept
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.outcome
Short description

deceased | permanent disability | etc.

Definition

Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

Data type

CodeableConcept

Binding

The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

ConditionOutcomeCodes (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
contributedToDeath0..1boolean
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.contributedToDeath
Short description

Whether the condition contributed to the cause of death

Definition

This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
onset[x]0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.onset[x]
Short description

When condition first manifested

Definition

Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

Requirements

Age of onset of a condition in relatives is predictive of risk for the patient.

Comments

The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string
onsetAgeAge
There are no (further) constraints on this element
Data type

Age

onsetRangeRange
There are no (further) constraints on this element
Data type

Range

onsetPeriodPeriod
There are no (further) constraints on this element
Data type

Period

onsetStringstring
There are no (further) constraints on this element
Data type

string

note0..*Annotation
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note
Short description

Extra information about condition

Definition

An area where general notes can be placed about this specific condition.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
id0..1string
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
author[x]Σ0..1
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.author[x]
Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
authorStringstring
There are no (further) constraints on this element
Data type

string

authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
There are no (further) constraints on this element
Data type

Reference(Practitioner | Patient | RelatedPerson | Organization)

timeΣ0..1dateTime
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.time
Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
textS Σ1..1markdown
There are no (further) constraints on this element
Element id
FamilyMemberHistory.condition.note.text
Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Data type

markdown

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="familymemberhistory-ca-ps" />
<url value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/familymemberhistory-ca-ps" />
<name value="FamilyMemberHistoryPSCA" />
<title value="Family Member History (PS-CA)" />
<status value="draft" />
<experimental value="false" />
<date value="2022-05-18T01:23:00-08:00" />
<description value="This profile represents the constraints applied to the FamilyMemberHistory resource by the PS-CA project. Currently, there is no equivalent IPS UV profile and no ISO CEN IPS 17269 requirements for a family history section. This profile is considered a draft version, and is informed and created as per the requirements of the first jurisdiction (i.e. Alberta) to pilot its use in patient summary within jurisdictional context. The constraints have been compared against other Family Member History FHIR profiles in Canada (OMD Core Data Set, Telus Patient Chart) and Internationally (Swiss Mednet, CareConnect UK, NDHM India) and share many constraints in common with those profiles but represent the minimum requirements as they are known in Canada today. This profile is expected to be refined further as more jurisdictional requirements are defined and as more is known about use in the international patient summary space." />
<copyright value="Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="FamilyMemberHistory" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" />
<derivation value="constraint" />
<snapshot>
<element id="FamilyMemberHistory">
<path value="FamilyMemberHistory" />
<short value="Information about patient's relatives, relevant for patient" />
<definition value="Significant health conditions for a person related to the patient relevant in the context of care for the patient." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory" />
<min value="0" />
<max value="*" />
</base>
<constraint>
<key value="dom-2" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
<expression value="contained.contained.empty()" />
<xpath value="not(parent::f:contained and f:contained)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-3" />
<severity value="error" />
<human value="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" />
<expression value="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()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-4" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-5" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
<expression value="contained.meta.security.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:security))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
<key value="dom-6" />
<severity value="warning" />
<human value="A resource should have narrative for robust management" />
<expression value="text.`div`.exists()" />
<xpath value="exists(f:text/h:div)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="fhs-1" />
<severity value="error" />
<human value="Can have age[x] or born[x], but not both" />
<expression value="age.empty() or born.empty()" />
<xpath value="not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])" />
</constraint>
<constraint>
<key value="fhs-2" />
<severity value="error" />
<human value="Can only have estimatedAge if age[x] is present" />
<expression value="age.exists() or estimatedAge.empty()" />
<xpath value="exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event" />
</mapping>
<mapping>
<identity value="v2" />
<map value="Not in scope for v2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Observation[classCode=OBS, moodCode=EVN]" />
</mapping>
</element>
<element id="FamilyMemberHistory.id">
<path value="FamilyMemberHistory.id" />
<short value="Logical id of this artifact" />
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="FamilyMemberHistory.meta">
<path value="FamilyMemberHistory.meta" />
<short value="Metadata about the resource" />
<definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.meta" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Meta" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="FamilyMemberHistory.implicitRules">
<path value="FamilyMemberHistory.implicitRules" />
<short value="A set of rules under which this content was created" />
<definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
<comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.implicitRules" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
<isSummary value="true" />
</element>
<element id="FamilyMemberHistory.language">
<path value="FamilyMemberHistory.language" />
<short value="Language of the resource content" />
<definition value="The base language in which the resource is written." />
<comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.language" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages" />
</binding>
</element>
<element id="FamilyMemberHistory.text">
<path value="FamilyMemberHistory.text" />
<short value="Text summary of the resource, for human interpretation" />
<definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." />
<comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." />
<alias value="narrative" />
<alias value="html" />
<alias value="xhtml" />
<alias value="display" />
<min value="0" />
<max value="1" />
<base>
<path value="DomainResource.text" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Narrative" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="Act.text?" />
</mapping>
</element>
<element id="FamilyMemberHistory.contained">
<path value="FamilyMemberHistory.contained" />
<short value="Contained, inline Resources" />
<definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." />
<comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." />
<alias value="inline resources" />
<alias value="anonymous resources" />
<alias value="contained resources" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.contained" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Resource" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension">
<path value="FamilyMemberHistory.extension" />
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.modifierExtension">
<path value="FamilyMemberHistory.modifierExtension" />
<short value="Extensions that cannot be ignored" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.identifier">
<path value="FamilyMemberHistory.identifier" />
<short value="External Id(s) for this record" />
<definition value="Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server." />
<comment value="This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number." />
<requirements value="Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.identifier" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Identifier" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="workflow" />
<map value="Event.identifier" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<mapping>
<identity value="rim" />
<map value="id" />
</mapping>
</element>
<element id="FamilyMemberHistory.instantiatesCanonical">
<path value="FamilyMemberHistory.instantiatesCanonical" />
<short value="Instantiates FHIR protocol or definition" />
<definition value="The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.instantiatesCanonical" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="canonical" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Questionnaire" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="workflow" />
<map value="Event.instantiatesCanonical" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=DEFN].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.instantiatesUri">
<path value="FamilyMemberHistory.instantiatesUri" />
<short value="Instantiates external protocol or definition" />
<definition value="The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory." />
<comment value="This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.instantiatesUri" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="workflow" />
<map value="Event.instantiatesUri" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=DEFN].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.status">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint">
<valueString value="default: completed" />
</extension>
<path value="FamilyMemberHistory.status" />
<short value="partial | completed | entered-in-error | health-unknown" />
<definition value="A code specifying the status of the record of the family history of a specific family member." />
<comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." />
<min value="1" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.status" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="true" />
<isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryStatus" />
</extension>
<strength value="required" />
<description value="A code that identifies the status of the family history record." />
<valueSet value="http://hl7.org/fhir/ValueSet/history-status|4.0.1" />
</binding>
<mapping>
<identity value="workflow" />
<map value="Event.status" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
</element>
<element id="FamilyMemberHistory.dataAbsentReason">
<path value="FamilyMemberHistory.dataAbsentReason" />
<short value="subject-unknown | withheld | unable-to-obtain | deferred" />
<definition value="Describes why the family member's history is not available." />
<requirements value="This is a separate element to allow it to have a distinct binding from reasonCode." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.dataAbsentReason" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryAbsentReason" />
</extension>
<strength value="example" />
<description value="Codes describing the reason why a family member's history is not available." />
<valueSet value="http://hl7.org/fhir/ValueSet/history-absent-reason" />
</binding>
<mapping>
<identity value="rim" />
<map value=".reasonCode" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient">
<path value="FamilyMemberHistory.patient" />
<short value="Patient history is about" />
<definition value="The person who this history concerns." />
<alias value="Proband" />
<min value="1" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.patient" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="workflow" />
<map value="Event.subject" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.subject[x]" />
</mapping>
<mapping>
<identity value="rim" />
<map value="participation[typeCode=SBJ].role" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.subject" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.id">
<path value="FamilyMemberHistory.patient.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.extension">
<path value="FamilyMemberHistory.patient.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.reference">
<path value="FamilyMemberHistory.patient.reference" />
<short value="Literal reference, Relative, internal or absolute URL" />
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
<min value="1" />
<max value="1" />
<base>
<path value="Reference.reference" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ref-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.type">
<path value="FamilyMemberHistory.patient.type" />
<short value="Type the reference refers to (e.g. "Patient")" />
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRResourceTypeExt" />
</extension>
<strength value="extensible" />
<description value="Aa resource (or, for logical models, the URI of the logical model)." />
<valueSet value="http://hl7.org/fhir/ValueSet/resource-types" />
</binding>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.identifier">
<path value="FamilyMemberHistory.patient.identifier" />
<short value="Logical reference, when literal reference is not known" />
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.identifier" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Identifier" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value=".identifier" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient.display">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="FamilyMemberHistory.patient.display" />
<short value="Text alternative for the resource" />
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.display" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.date">
<path value="FamilyMemberHistory.date" />
<short value="When history was recorded or last updated" />
<definition value="The date (and possibly time) when the family member history was recorded or last updated." />
<comment value="This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
<requirements value="Allows determination of how current the summary is." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.date" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="w5" />
<map value="FiveWs.recorded" />
</mapping>
<mapping>
<identity value="rim" />
<map value="participation[typeCode=AUT].time" />
</mapping>
</element>
<element id="FamilyMemberHistory.name">
<path value="FamilyMemberHistory.name" />
<short value="The family member described" />
<definition value="This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair"." />
<requirements value="Allows greater ease in ensuring the same person is being talked about." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.name" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="name" />
</mapping>
</element>
<element id="FamilyMemberHistory.relationship">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0" />
</extension>
<path value="FamilyMemberHistory.relationship" />
<short value="Concept - reference to a terminology or just text" />
<definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text." />
<comment value="For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text." />
<min value="1" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.relationship" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilialRelationship" />
</extension>
<strength value="example" />
<description value="The nature of the relationship between the patient and the related person being described in the family member history." />
<valueSet value="http://terminology.hl7.org/ValueSet/v3-FamilyMember" />
</binding>
<mapping>
<identity value="rim" />
<map value="code" />
</mapping>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
</element>
<element id="FamilyMemberHistory.sex">
<path value="FamilyMemberHistory.sex" />
<short value="male | female | other | unknown" />
<definition value="The birth sex of the family member." />
<comment value="This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element." />
<requirements value="Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.sex" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Sex" />
</extension>
<strength value="extensible" />
<description value="Codes describing the sex assigned at birth as documented on the birth registration." />
<valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
</binding>
</element>
<element id="FamilyMemberHistory.born[x]">
<path value="FamilyMemberHistory.born[x]" />
<short value="(approximate) date of birth" />
<definition value="The actual or approximate date of birth of the relative." />
<requirements value="Allows calculation of the relative's age." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.born[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<type>
<code value="date" />
</type>
<type>
<code value="string" />
</type>
<condition value="fhs-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)" />
</mapping>
</element>
<element id="FamilyMemberHistory.age[x]">
<path value="FamilyMemberHistory.age[x]" />
<short value="(approximate) age" />
<definition value="The age of the relative at the time the family member history is recorded." />
<comment value="use estimatedAge to indicate whether the age is actual or not." />
<requirements value="While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.age[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Age" />
</type>
<type>
<code value="Range" />
</type>
<type>
<code value="string" />
</type>
<condition value="fhs-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.estimatedAge">
<path value="FamilyMemberHistory.estimatedAge" />
<short value="Age is estimated?" />
<definition value="If true, indicates that the age value specified is an estimated value." />
<comment value="This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age." />
<requirements value="Clinicians often prefer to specify an estimaged age rather than an age range." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.estimatedAge" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="boolean" />
</type>
<meaningWhenMissing value="It is unknown whether the age is an estimate or not" />
<condition value="fhs-2" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="FamilyMemberHistory.deceased[x]">
<path value="FamilyMemberHistory.deceased[x]" />
<short value="Dead? How old/when?" />
<definition value="Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.deceased[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="boolean" />
</type>
<type>
<code value="Age" />
</type>
<type>
<code value="Range" />
</type>
<type>
<code value="date" />
</type>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role" />
</mapping>
</element>
<element id="FamilyMemberHistory.reasonCode">
<path value="FamilyMemberHistory.reasonCode" />
<short value="Why was family member history performed?" />
<definition value="Describes why the family member history occurred in coded or textual form." />
<comment value="Textual reasons can be captured using reasonCode.text." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.reasonCode" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryReason" />
</extension>
<strength value="example" />
<description value="Codes indicating why the family member history was done." />
<valueSet value="http://hl7.org/fhir/ValueSet/clinical-findings" />
</binding>
<mapping>
<identity value="workflow" />
<map value="Event.reasonCode" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.why[x]" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".reasonCode" />
</mapping>
</element>
<element id="FamilyMemberHistory.reasonReference">
<path value="FamilyMemberHistory.reasonReference" />
<short value="Why was family member history performed?" />
<definition value="Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.reasonReference" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="workflow" />
<map value="Event.reasonReference" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.why[x]" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=RSON].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.note">
<path value="FamilyMemberHistory.note" />
<short value="General note about related person" />
<definition value="This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.note" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Annotation" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="workflow" />
<map value="Event.note" />
</mapping>
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.note.id">
<path value="FamilyMemberHistory.note.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.note.extension">
<path value="FamilyMemberHistory.note.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.note.author[x]">
<path value="FamilyMemberHistory.note.author[x]" />
<short value="Individual responsible for the annotation" />
<definition value="The individual responsible for making the annotation." />
<comment value="Organization is used when there's no need for specific attribution as to who made the comment." />
<min value="0" />
<max value="1" />
<base>
<path value="Annotation.author[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
</type>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.participant[typeCode=AUT].role" />
</mapping>
</element>
<element id="FamilyMemberHistory.note.time">
<path value="FamilyMemberHistory.note.time" />
<short value="When the annotation was made" />
<definition value="Indicates when this particular annotation was made." />
<min value="0" />
<max value="1" />
<base>
<path value="Annotation.time" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.effectiveTime" />
</mapping>
</element>
<element id="FamilyMemberHistory.note.text">
<path value="FamilyMemberHistory.note.text" />
<short value="The annotation - text content (as markdown)" />
<definition value="The text of the annotation in markdown format." />
<comment value="Family_History_Notes" />
<min value="1" />
<max value="1" />
<base>
<path value="Annotation.text" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="markdown" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.text" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition">
<path value="FamilyMemberHistory.condition" />
<short value="Condition that the related person had" />
<definition value="The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition." />
<comment value="This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.condition" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="BackboneElement" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.id">
<path value="FamilyMemberHistory.condition.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.extension">
<path value="FamilyMemberHistory.condition.extension" />
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.modifierExtension">
<path value="FamilyMemberHistory.condition.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<base>
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.code">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0" />
</extension>
<path value="FamilyMemberHistory.condition.code" />
<short value="Concept - reference to a terminology or just text" />
<definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text." />
<comment value="For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text." />
<min value="1" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.condition.code" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ConditionCode" />
</extension>
<strength value="example" />
<description value="Identification of the Condition or diagnosis." />
<valueSet value="http://hl7.org/fhir/ValueSet/condition-code" />
</binding>
<mapping>
<identity value="rim" />
<map value=".value" />
</mapping>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.outcome">
<path value="FamilyMemberHistory.condition.outcome" />
<short value="deceased | permanent disability | etc." />
<definition value="Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.condition.outcome" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ConditionOutcome" />
</extension>
<strength value="example" />
<description value="The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc." />
<valueSet value="http://hl7.org/fhir/ValueSet/condition-outcome" />
</binding>
<mapping>
<identity value="rim" />
<map value="outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.contributedToDeath">
<path value="FamilyMemberHistory.condition.contributedToDeath" />
<short value="Whether the condition contributed to the cause of death" />
<definition value="This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.condition.contributedToDeath" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="boolean" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
</element>
<element id="FamilyMemberHistory.condition.onset[x]">
<path value="FamilyMemberHistory.condition.onset[x]" />
<short value="When condition first manifested" />
<definition value="Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence." />
<comment value="The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString." />
<requirements value="Age of onset of a condition in relatives is predictive of risk for the patient." />
<min value="0" />
<max value="1" />
<base>
<path value="FamilyMemberHistory.condition.onset[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Age" />
</type>
<type>
<code value="Range" />
</type>
<type>
<code value="Period" />
</type>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note">
<path value="FamilyMemberHistory.condition.note" />
<short value="Extra information about condition" />
<definition value="An area where general notes can be placed about this specific condition." />
<min value="0" />
<max value="*" />
<base>
<path value="FamilyMemberHistory.condition.note" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Annotation" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note.id">
<path value="FamilyMemberHistory.condition.note.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note.extension">
<path value="FamilyMemberHistory.condition.note.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note.author[x]">
<path value="FamilyMemberHistory.condition.note.author[x]" />
<short value="Individual responsible for the annotation" />
<definition value="The individual responsible for making the annotation." />
<comment value="Organization is used when there's no need for specific attribution as to who made the comment." />
<min value="0" />
<max value="1" />
<base>
<path value="Annotation.author[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
</type>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.participant[typeCode=AUT].role" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note.time">
<path value="FamilyMemberHistory.condition.note.time" />
<short value="When the annotation was made" />
<definition value="Indicates when this particular annotation was made." />
<min value="0" />
<max value="1" />
<base>
<path value="Annotation.time" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.effectiveTime" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note.text">
<path value="FamilyMemberHistory.condition.note.text" />
<short value="The annotation - text content (as markdown)" />
<definition value="The text of the annotation in markdown format." />
<min value="1" />
<max value="1" />
<base>
<path value="Annotation.text" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="markdown" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.text" />
</mapping>
</element>
</snapshot>
<differential>
<element id="FamilyMemberHistory.status">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint">
<valueString value="default: completed" />
</extension>
<path value="FamilyMemberHistory.status" />
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.patient">
<path value="FamilyMemberHistory.patient" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" />
</type>
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.patient.reference">
<path value="FamilyMemberHistory.patient.reference" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.date">
<path value="FamilyMemberHistory.date" />
<comment value="This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
</element>
<element id="FamilyMemberHistory.relationship">
<path value="FamilyMemberHistory.relationship" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.note">
<path value="FamilyMemberHistory.note" />
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.note.text">
<path value="FamilyMemberHistory.note.text" />
<comment value="Family_History_Notes" />
<mustSupport value="true" />
</element>
<element id="FamilyMemberHistory.condition">
<path value="FamilyMemberHistory.condition" />
<comment value="This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
</element>
<element id="FamilyMemberHistory.condition.code">
<path value="FamilyMemberHistory.condition.code" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
</element>
<element id="FamilyMemberHistory.condition.onset[x]">
<path value="FamilyMemberHistory.condition.onset[x]" />
<comment value="The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString." />
</element>
<element id="FamilyMemberHistory.condition.note.text">
<path value="FamilyMemberHistory.condition.note.text" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "familymemberhistory-ca-ps",
"url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/familymemberhistory-ca-ps",
"name": "FamilyMemberHistoryPSCA",
"title": "Family Member History (PS-CA)",
"status": "draft",
"experimental": false,
"date": "2022-05-18T01:23:00-08:00",
"description": "This profile represents the constraints applied to the FamilyMemberHistory resource by the PS-CA project. Currently, there is no equivalent IPS UV profile and no ISO CEN IPS 17269 requirements for a family history section. This profile is considered a draft version, and is informed and created as per the requirements of the first jurisdiction (i.e. Alberta) to pilot its use in patient summary within jurisdictional context. The constraints have been compared against other Family Member History FHIR profiles in Canada (OMD Core Data Set, Telus Patient Chart) and Internationally (Swiss Mednet, CareConnect UK, NDHM India) and share many constraints in common with those profiles but represent the minimum requirements as they are known in Canada today. This profile is expected to be refined further as more jurisdictional requirements are defined and as more is known about use in the international patient summary space.",
"copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "FamilyMemberHistory",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "FamilyMemberHistory",
"path": "FamilyMemberHistory",
"short": "Information about patient's relatives, relevant for patient",
"definition": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "fhs-1",
"severity": "error",
"human": "Can have age[x] or born[x], but not both",
"expression": "age.empty() or born.empty()",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"
},
{
"key": "fhs-2",
"severity": "error",
"human": "Can only have estimatedAge if age[x] is present",
"expression": "age.exists() or estimatedAge.empty()",
"xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"id": "FamilyMemberHistory.id",
"path": "FamilyMemberHistory.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "FamilyMemberHistory.meta",
"path": "FamilyMemberHistory.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "FamilyMemberHistory.implicitRules",
"path": "FamilyMemberHistory.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "FamilyMemberHistory.language",
"path": "FamilyMemberHistory.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "FamilyMemberHistory.text",
"path": "FamilyMemberHistory.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "FamilyMemberHistory.contained",
"path": "FamilyMemberHistory.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension",
"path": "FamilyMemberHistory.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.modifierExtension",
"path": "FamilyMemberHistory.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.identifier",
"path": "FamilyMemberHistory.identifier",
"short": "External Id(s) for this record",
"definition": "Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements": "Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"id": "FamilyMemberHistory.instantiatesCanonical",
"path": "FamilyMemberHistory.instantiatesCanonical",
"short": "Instantiates FHIR protocol or definition",
"definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.instantiatesCanonical",
"min": 0,
"max": "*"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.instantiatesCanonical"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.instantiatesUri",
"path": "FamilyMemberHistory.instantiatesUri",
"short": "Instantiates external protocol or definition",
"definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.instantiatesUri",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.instantiatesUri"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.status",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: completed"
}
],
"path": "FamilyMemberHistory.status",
"short": "partial | completed | entered-in-error | health-unknown",
"definition": "A code specifying the status of the record of the family history of a specific family member.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryStatus"
}
],
"strength": "required",
"description": "A code that identifies the status of the family history record.",
"valueSet": "http://hl7.org/fhir/ValueSet/history-status|4.0.1"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "FamilyMemberHistory.dataAbsentReason",
"path": "FamilyMemberHistory.dataAbsentReason",
"short": "subject-unknown | withheld | unable-to-obtain | deferred",
"definition": "Describes why the family member's history is not available.",
"requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.dataAbsentReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryAbsentReason"
}
],
"strength": "example",
"description": "Codes describing the reason why a family member's history is not available.",
"valueSet": "http://hl7.org/fhir/ValueSet/history-absent-reason"
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"short": "Patient history is about",
"definition": "The person who this history concerns.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "FamilyMemberHistory.patient.id",
"path": "FamilyMemberHistory.patient.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.patient.extension",
"path": "FamilyMemberHistory.patient.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.patient.reference",
"path": "FamilyMemberHistory.patient.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 1,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.patient.type",
"path": "FamilyMemberHistory.patient.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.patient.identifier",
"path": "FamilyMemberHistory.patient.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "FamilyMemberHistory.patient.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "FamilyMemberHistory.patient.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.date",
"path": "FamilyMemberHistory.date",
"short": "When history was recorded or last updated",
"definition": "The date (and possibly time) when the family member history was recorded or last updated.",
"comment": "This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"id": "FamilyMemberHistory.name",
"path": "FamilyMemberHistory.name",
"short": "The family member described",
"definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
},
{
"id": "FamilyMemberHistory.relationship",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}
],
"path": "FamilyMemberHistory.relationship",
"short": "Concept - reference to a terminology or just text",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.relationship",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilialRelationship"
}
],
"strength": "example",
"description": "The nature of the relationship between the patient and the related person being described in the family member history.",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-FamilyMember"
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id": "FamilyMemberHistory.sex",
"path": "FamilyMemberHistory.sex",
"short": "male | female | other | unknown",
"definition": "The birth sex of the family member.",
"comment": "This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.",
"requirements": "Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.sex",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Sex"
}
],
"strength": "extensible",
"description": "Codes describing the sex assigned at birth as documented on the birth registration.",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"id": "FamilyMemberHistory.born[x]",
"path": "FamilyMemberHistory.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.born[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"id": "FamilyMemberHistory.age[x]",
"path": "FamilyMemberHistory.age[x]",
"short": "(approximate) age",
"definition": "The age of the relative at the time the family member history is recorded.",
"comment": "use estimatedAge to indicate whether the age is actual or not.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.age[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"id": "FamilyMemberHistory.estimatedAge",
"path": "FamilyMemberHistory.estimatedAge",
"short": "Age is estimated?",
"definition": "If true, indicates that the age value specified is an estimated value.",
"comment": "This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.",
"requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.estimatedAge",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "It is unknown whether the age is an estimate or not",
"condition": [
"fhs-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "FamilyMemberHistory.deceased[x]",
"path": "FamilyMemberHistory.deceased[x]",
"short": "Dead? How old/when?",
"definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.deceased[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"
}
]
},
{
"id": "FamilyMemberHistory.reasonCode",
"path": "FamilyMemberHistory.reasonCode",
"short": "Why was family member history performed?",
"definition": "Describes why the family member history occurred in coded or textual form.",
"comment": "Textual reasons can be captured using reasonCode.text.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryReason"
}
],
"strength": "example",
"description": "Codes indicating why the family member history was done.",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.reasonReference",
"path": "FamilyMemberHistory.reasonReference",
"short": "Why was family member history performed?",
"definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "FamilyMemberHistory.note",
"path": "FamilyMemberHistory.note",
"short": "General note about related person",
"definition": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"id": "FamilyMemberHistory.note.id",
"path": "FamilyMemberHistory.note.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.note.extension",
"path": "FamilyMemberHistory.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.note.author[x]",
"path": "FamilyMemberHistory.note.author[x]",
"short": "Individual responsible for the annotation",
"definition": "The individual responsible for making the annotation.",
"comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.author[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.participant[typeCode=AUT].role"
}
]
},
{
"id": "FamilyMemberHistory.note.time",
"path": "FamilyMemberHistory.note.time",
"short": "When the annotation was made",
"definition": "Indicates when this particular annotation was made.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.effectiveTime"
}
]
},
{
"id": "FamilyMemberHistory.note.text",
"path": "FamilyMemberHistory.note.text",
"short": "The annotation - text content (as markdown)",
"definition": "The text of the annotation in markdown format.",
"comment": "Family_History_Notes",
"min": 1,
"max": "1",
"base": {
"path": "Annotation.text",
"min": 1,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text"
}
]
},
{
"id": "FamilyMemberHistory.condition",
"path": "FamilyMemberHistory.condition",
"short": "Condition that the related person had",
"definition": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.",
"comment": "This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.condition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"id": "FamilyMemberHistory.condition.id",
"path": "FamilyMemberHistory.condition.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.extension",
"path": "FamilyMemberHistory.condition.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.modifierExtension",
"path": "FamilyMemberHistory.condition.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.condition.code",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}
],
"path": "FamilyMemberHistory.condition.code",
"short": "Concept - reference to a terminology or just text",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionCode"
}
],
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id": "FamilyMemberHistory.condition.outcome",
"path": "FamilyMemberHistory.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.outcome",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionOutcome"
}
],
"strength": "example",
"description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-outcome"
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"id": "FamilyMemberHistory.condition.contributedToDeath",
"path": "FamilyMemberHistory.condition.contributedToDeath",
"short": "Whether the condition contributed to the cause of death",
"definition": "This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.contributedToDeath",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "FamilyMemberHistory.condition.onset[x]",
"path": "FamilyMemberHistory.condition.onset[x]",
"short": "When condition first manifested",
"definition": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"comment": "The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.onset[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"
}
]
},
{
"id": "FamilyMemberHistory.condition.note",
"path": "FamilyMemberHistory.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.condition.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"id": "FamilyMemberHistory.condition.note.id",
"path": "FamilyMemberHistory.condition.note.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.note.extension",
"path": "FamilyMemberHistory.condition.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.note.author[x]",
"path": "FamilyMemberHistory.condition.note.author[x]",
"short": "Individual responsible for the annotation",
"definition": "The individual responsible for making the annotation.",
"comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.author[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.participant[typeCode=AUT].role"
}
]
},
{
"id": "FamilyMemberHistory.condition.note.time",
"path": "FamilyMemberHistory.condition.note.time",
"short": "When the annotation was made",
"definition": "Indicates when this particular annotation was made.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.effectiveTime"
}
]
},
{
"id": "FamilyMemberHistory.condition.note.text",
"path": "FamilyMemberHistory.condition.note.text",
"short": "The annotation - text content (as markdown)",
"definition": "The text of the annotation in markdown format.",
"min": 1,
"max": "1",
"base": {
"path": "Annotation.text",
"min": 1,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text"
}
]
}
]
},
"differential": {
"element": [
{
"id": "FamilyMemberHistory.status",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: completed"
}
],
"path": "FamilyMemberHistory.status",
"mustSupport": true
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps"
]
}
],
"mustSupport": true
},
{
"id": "FamilyMemberHistory.patient.reference",
"path": "FamilyMemberHistory.patient.reference",
"min": 1,
"mustSupport": true
},
{
"id": "FamilyMemberHistory.date",
"path": "FamilyMemberHistory.date",
"comment": "This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems.\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received."
},
{
"id": "FamilyMemberHistory.relationship",
"path": "FamilyMemberHistory.relationship",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"mustSupport": true
},
{
"id": "FamilyMemberHistory.note",
"path": "FamilyMemberHistory.note",
"mustSupport": true
},
{
"id": "FamilyMemberHistory.note.text",
"path": "FamilyMemberHistory.note.text",
"comment": "Family_History_Notes",
"mustSupport": true
},
{
"id": "FamilyMemberHistory.condition",
"path": "FamilyMemberHistory.condition",
"comment": "This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. .\n\n Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received."
},
{
"id": "FamilyMemberHistory.condition.code",
"path": "FamilyMemberHistory.condition.code",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
]
},
{
"id": "FamilyMemberHistory.condition.onset[x]",
"path": "FamilyMemberHistory.condition.onset[x]",
"comment": "The data types for this element are not constrained to provide maximum ability for reuse/refinement during draft stage. However, initial implementers using this profile to communicate family history for patient summaries that support semi-structured data for each condition are likely to utilize onsetString."
},
{
"id": "FamilyMemberHistory.condition.note.text",
"path": "FamilyMemberHistory.condition.note.text",
"mustSupport": true
}
]
}
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
FamilyMemberHistory.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
FamilyMemberHistory.statusrequiredhttp://hl7.org/fhir/ValueSet/history-status|4.0.1
FamilyMemberHistory.dataAbsentReasonexamplehttp://hl7.org/fhir/ValueSet/history-absent-reason
FamilyMemberHistory.patient.typeextensiblehttp://hl7.org/fhir/ValueSet/resource-types
FamilyMemberHistory.relationshipexamplehttp://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensiblehttp://hl7.org/fhir/ValueSet/administrative-gender
FamilyMemberHistory.reasonCodeexamplehttp://hl7.org/fhir/ValueSet/clinical-findings
FamilyMemberHistory.condition.codeexamplehttp://hl7.org/fhir/ValueSet/condition-code
FamilyMemberHistory.condition.outcomeexamplehttp://hl7.org/fhir/ValueSet/condition-outcome

Constraints

Obligations

Key Differences between the IPS-UV and PS-CA

This is a draft profile that PS-CA has developed for a piloting jurisdiction. It will be surfaced for IPS inclusion following a successful pilot period.

IG © based on FHIR R4 | Package package:ca.infoway.io.psca@2.1.0-DFT
HL7® and FHIR® are the registered trademarks of Health Level Seven International