MII_IG_MolGen_1

Familienanamnese - FamilyMemberHistory

Beschreibung

Details zur Krankengeschichte von verwandten Familienmitgliedern.

Name	Canonical
MII_PR_MolGen_Familienanamnese	https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/familienanamnese

Diff

MII_PR_MolGen_Familienanamnese (FamilyMemberHistory)

FamilyMemberHistory

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]
MII-KDS: mide-dataelement-1740

0..1

string

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

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..1

uri

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())

language

0..1

codeBinding

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

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

Narrative

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?

contained

0..*

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

extension

0..*

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

?! C

0..*

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

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

status

S Σ ?!

1..1

codeBinding

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..1

CodeableConcept

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

patient

S Σ

1..1

Reference(Patient)

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(Patient)

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

date

S Σ

0..1

dateTime

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 should be captured even if the same as the date on the List aggregating the full family history.

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..1

string

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

relationship

S Σ

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship

Short description

Relationship to the subject

Definition

The type of relationship this person has to the patient (father, mother, brother etc.).

Data type

CodeableConcept

Binding

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

v3.FamilyMember (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: code

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.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

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

coding

1..*

Coding

Element id

FamilyMemberHistory.relationship.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomed

1..1

CodingBindingPattern

Element id

FamilyMemberHistory.relationship.coding:snomed

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_MolGen_FamilyMember_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Verwandtschaftsgrad

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:Verwandtschaftsgrad

Short description

MII EX Mol Gen Verwandtschaftsgrad

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe eines Verwandtschaftsgrades zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsgrad

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Verwandtschaftsverhaeltnis

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:Verwandtschaftsverhaeltnis

Short description

MII EX MolGen Verwandtschaftsverhaeltnis

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe eines Verwandtschaftsverhältnisses zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsverhaeltnis

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

FamiliareLinie

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:FamiliareLinie

Short description

MII EX MolGen Familiare Linie

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe der familiären Linie zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-familiare-linie

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

0..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

v3-RoleCode

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.relationship.coding:v3-RoleCode

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

v3.PersonalRelationshipRoleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

sex

S Σ

0..1

CodeableConceptBinding

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]

0..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)

bornPeriod

Period

There are no (further) constraints on this element

Data type

Period

bornDate

date

There are no (further) constraints on this element

Data type

date

bornString

string

There are no (further) constraints on this element

Data type

string

age[x]

Σ C

0..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

ageAge

Age

There are no (further) constraints on this element

Data type

Age

ageRange

Range

There are no (further) constraints on this element

Data type

Range

ageString

string

There are no (further) constraints on this element

Data type

string

estimatedAge

Σ C

0..1

boolean

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

deceasedBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

deceasedAge

Age

There are no (further) constraints on this element

Data type

Age

deceasedRange

Range

There are no (further) constraints on this element

Data type

Range

deceasedDate

date

There are no (further) constraints on this element

Data type

date

deceasedString

string

There are no (further) constraints on this element

Data type

string

reasonCode

S Σ

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

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

S Σ

1..*

Coding

Element id

FamilyMemberHistory.reasonCode.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

icd10-gm

S Σ

0..1

CodingICD10GMBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingICD10GM

Binding

ICD10GMVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/icd-10-gm"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Mehrfachcodierungs-Kennzeichen

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Mehrfachcodierungs-Kennzeichen

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-mehrfachcodierungs-kennzeichen

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Seitenlokalisation

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Seitenlokalisation

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/seitenlokalisation

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Diagnosesicherheit

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Diagnosesicherheit

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-diagnosesicherheit

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.system

Short description

Canonische CodeSystem URL für ICD-10-GM

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Pattern

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

S Σ

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.version

Short description

Die Jahresversion von ICD-10-GM. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Bie Verwendung von ICD-10-GM ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von ICD-10-GM ein neues Codesystem darstellt.

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.code

Short description

Der ICD-10-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
icd-regex: In code sind nur gültige ICD-10-Codes ohne Zusätze erlaubt
matches('^[A-Z][0-9][A-Z0-9](\\.?[A-Z0-9]{0,4})?$')

Examples
Einfacher ICD-Code

F17.4

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

alpha-id

S Σ

0..1

CodingAlphaIDBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingAlphaID

Binding

AlphaIdVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/alpha-id"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.system

Short description

Canonische CodeSystem URL für Alpha-ID

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/alpha-id

Pattern

http://fhir.de/CodeSystem/bfarm/alpha-id

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.version

Short description

Die Jahresversion von Alpha-ID. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Bie Verwendung von Alpha-ID ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von Alpha-ID ein neues Codesystem darstellt.

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.code

Short description

Der Alpha-ID-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

sct

S Σ

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:sct

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_Diagnose_DiagnoseCodes_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

orphanet

S Σ

0..1

CodingPattern

Element id

FamilyMemberHistory.reasonCode.coding:orphanet

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://www.orpha.net"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://www.orpha.net

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonReference

S Σ

0..*

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

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

note

0..*

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

condition

0..*

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.

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]

0..1

string

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

extension

0..*

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

Comments

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

Σ ?! C

0..*

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

Comments

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

code

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code

Short description

Condition suffered by relation

Definition

The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

Data type

CodeableConcept

Binding

Identification of the Condition or diagnosis.

Condition/Problem/DiagnosisCodes (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .value

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

S Σ

1..*

Coding

Element id

FamilyMemberHistory.condition.code.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

icd10-gm

S Σ

0..1

CodingICD10GMBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingICD10GM

Binding

ICD10GMVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/icd-10-gm"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Mehrfachcodierungs-Kennzeichen

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Mehrfachcodierungs-Kennzeichen

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-mehrfachcodierungs-kennzeichen

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Seitenlokalisation

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Seitenlokalisation

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/seitenlokalisation

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Diagnosesicherheit

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Diagnosesicherheit

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-diagnosesicherheit

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.system

Short description

Canonische CodeSystem URL für ICD-10-GM

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Pattern

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

S Σ

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.version

Short description

Die Jahresversion von ICD-10-GM. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.code

Short description

Der ICD-10-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
icd-regex: In code sind nur gültige ICD-10-Codes ohne Zusätze erlaubt
matches('^[A-Z][0-9][A-Z0-9](\\.?[A-Z0-9]{0,4})?$')

Examples
Einfacher ICD-Code

F17.4

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

alpha-id

S Σ

0..1

CodingAlphaIDBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:alpha-id

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingAlphaID

Binding

AlphaIdVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/alpha-id"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.system

Short description

Canonische CodeSystem URL für Alpha-ID

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/alpha-id

Pattern

http://fhir.de/CodeSystem/bfarm/alpha-id

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.version

Short description

Die Jahresversion von Alpha-ID. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.code

Short description

Der Alpha-ID-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

sct

S Σ

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:sct

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_Diagnose_DiagnoseCodes_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

orphanet

S Σ

0..1

CodingPattern

Element id

FamilyMemberHistory.condition.code.coding:orphanet

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://www.orpha.net"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://www.orpha.net

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

outcome

0..1

CodeableConcept

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

contributedToDeath

0..1

boolean

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.

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

onsetAge

Age

There are no (further) constraints on this element

Data type

Age

onsetRange

Range

There are no (further) constraints on this element

Data type

Range

onsetPeriod

Period

There are no (further) constraints on this element

Data type

Period

onsetString

string

There are no (further) constraints on this element

Data type

string

note

0..*

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

Snapshot

MII_PR_MolGen_Familienanamnese (FamilyMemberHistory)

FamilyMemberHistory

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]
MII-KDS: mide-dataelement-1740

0..1

string

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

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..1

uri

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

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

Narrative

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

Comments

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?

contained

0..*

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

Comments

Data type

Resource

Mappings

rim: N/A

extension

0..*

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

Comments

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

?! C

0..*

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

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

Requirements

Comments

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

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

status

S Σ ?!

1..1

codeBinding

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..1

CodeableConcept

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

patient

S Σ

1..1

Reference(Patient)

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(Patient)

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

date

S Σ

0..1

dateTime

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 should be captured even if the same as the date on the List aggregating the full family history.

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..1

string

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

relationship

S Σ

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship

Short description

Relationship to the subject

Definition

The type of relationship this person has to the patient (father, mother, brother etc.).

Data type

CodeableConcept

Binding

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

v3.FamilyMember (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: code

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

1..*

Coding

Element id

FamilyMemberHistory.relationship.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomed

1..1

CodingBindingPattern

Element id

FamilyMemberHistory.relationship.coding:snomed

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_MolGen_FamilyMember_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Verwandtschaftsgrad

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:Verwandtschaftsgrad

Short description

MII EX Mol Gen Verwandtschaftsgrad

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe eines Verwandtschaftsgrades zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsgrad

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Verwandtschaftsverhaeltnis

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:Verwandtschaftsverhaeltnis

Short description

MII EX MolGen Verwandtschaftsverhaeltnis

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe eines Verwandtschaftsverhältnisses zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsverhaeltnis

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

FamiliareLinie

S C

0..1

Extension(Coding)

Element id

FamilyMemberHistory.relationship.coding:snomed.extension:FamiliareLinie

Short description

MII EX MolGen Familiare Linie

Alternate names

extensions, user content

Definition

Extension erlaubt die Angabe der familiären Linie zwischen Patient und Familienangehörigen.

Comments

Data type

Extension(Coding)

Extension URL

https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-familiare-linie

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

0..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.coding:snomed.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

v3-RoleCode

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.relationship.coding:v3-RoleCode

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

v3.PersonalRelationshipRoleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.relationship.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

sex

S Σ

0..1

CodeableConceptBinding

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

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]

0..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)

bornPeriod

Period

There are no (further) constraints on this element

Data type

Period

bornDate

date

There are no (further) constraints on this element

Data type

date

bornString

string

There are no (further) constraints on this element

Data type

string

age[x]

Σ C

0..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

ageAge

Age

There are no (further) constraints on this element

Data type

Age

ageRange

Range

There are no (further) constraints on this element

Data type

Range

ageString

string

There are no (further) constraints on this element

Data type

string

estimatedAge

Σ C

0..1

boolean

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

deceasedBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

deceasedAge

Age

There are no (further) constraints on this element

Data type

Age

deceasedRange

Range

There are no (further) constraints on this element

Data type

Range

deceasedDate

date

There are no (further) constraints on this element

Data type

date

deceasedString

string

There are no (further) constraints on this element

Data type

string

reasonCode

S Σ

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

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

S Σ

1..*

Coding

Element id

FamilyMemberHistory.reasonCode.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

icd10-gm

S Σ

0..1

CodingICD10GMBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingICD10GM

Binding

ICD10GMVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/icd-10-gm"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Mehrfachcodierungs-Kennzeichen

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Mehrfachcodierungs-Kennzeichen

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-mehrfachcodierungs-kennzeichen

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Seitenlokalisation

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Seitenlokalisation

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/seitenlokalisation

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Diagnosesicherheit

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.extension:Diagnosesicherheit

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-diagnosesicherheit

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.system

Short description

Canonische CodeSystem URL für ICD-10-GM

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Pattern

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

S Σ

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.version

Short description

Die Jahresversion von ICD-10-GM. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.code

Short description

Der ICD-10-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
icd-regex: In code sind nur gültige ICD-10-Codes ohne Zusätze erlaubt
matches('^[A-Z][0-9][A-Z0-9](\\.?[A-Z0-9]{0,4})?$')

Examples
Einfacher ICD-Code

F17.4

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:icd10-gm.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

alpha-id

S Σ

0..1

CodingAlphaIDBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingAlphaID

Binding

AlphaIdVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/alpha-id"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.system

Short description

Canonische CodeSystem URL für Alpha-ID

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/alpha-id

Pattern

http://fhir.de/CodeSystem/bfarm/alpha-id

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.version

Short description

Die Jahresversion von Alpha-ID. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.code

Short description

Der Alpha-ID-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:alpha-id.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

sct

S Σ

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.reasonCode.coding:sct

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_Diagnose_DiagnoseCodes_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:sct.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

orphanet

S Σ

0..1

CodingPattern

Element id

FamilyMemberHistory.reasonCode.coding:orphanet

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://www.orpha.net"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://www.orpha.net

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.coding:orphanet.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.reasonCode.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

reasonReference

S Σ

0..*

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

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

note

0..*

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

condition

0..*

BackboneElement

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition

Short description

Condition that the related person had

Definition

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]

0..1

string

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

extension

0..*

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

Comments

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

Σ ?! C

0..*

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

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

Requirements

Comments

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

code

1..1

CodeableConcept

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code

Short description

Condition suffered by relation

Definition

Data type

CodeableConcept

Binding

Identification of the Condition or diagnosis.

Condition/Problem/DiagnosisCodes (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .value

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

S Σ

1..*

Coding

Element id

FamilyMemberHistory.condition.code.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by $this(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

icd10-gm

S Σ

0..1

CodingICD10GMBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingICD10GM

Binding

ICD10GMVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/icd-10-gm"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

Mehrfachcodierungs-Kennzeichen

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Mehrfachcodierungs-Kennzeichen

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-mehrfachcodierungs-kennzeichen

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Seitenlokalisation

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Seitenlokalisation

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/seitenlokalisation

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Diagnosesicherheit

0..1

Extension(Coding)

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.extension:Diagnosesicherheit

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://fhir.de/StructureDefinition/icd-10-gm-diagnosesicherheit

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())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.system

Short description

Canonische CodeSystem URL für ICD-10-GM

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Pattern

http://fhir.de/CodeSystem/bfarm/icd-10-gm

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

S Σ

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.version

Short description

Die Jahresversion von ICD-10-GM. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.code

Short description

Der ICD-10-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
icd-regex: In code sind nur gültige ICD-10-Codes ohne Zusätze erlaubt
matches('^[A-Z][0-9][A-Z0-9](\\.?[A-Z0-9]{0,4})?$')

Examples
Einfacher ICD-Code

F17.4

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:icd10-gm.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

alpha-id

S Σ

0..1

CodingAlphaIDBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:alpha-id

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingAlphaID

Binding

AlphaIdVS (required)

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())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/alpha-id"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriFixed ValuePattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.system

Short description

Canonische CodeSystem URL für Alpha-ID

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/bfarm/alpha-id

Pattern

http://fhir.de/CodeSystem/bfarm/alpha-id

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

1..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.version

Short description

Die Jahresversion von Alpha-ID. Angegeben wird immer die vierstellige Jahreszahl (z.B. "2017")

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.code

Short description

Der Alpha-ID-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:alpha-id.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

sct

S Σ

0..1

CodingBindingPattern

Element id

FamilyMemberHistory.condition.code.coding:sct

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

MII_VS_Diagnose_DiagnoseCodes_SNOMED (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:sct.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

orphanet

S Σ

0..1

CodingPattern

Element id

FamilyMemberHistory.condition.code.coding:orphanet

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://www.orpha.net"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://www.orpha.net

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

code

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.coding:orphanet.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

FamilyMemberHistory.condition.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

outcome

0..1

CodeableConcept

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

contributedToDeath

0..1

boolean

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.

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

onsetAge

Age

There are no (further) constraints on this element

Data type

Age

onsetRange

Range

There are no (further) constraints on this element

Data type

Range

onsetPeriod

Period

There are no (further) constraints on this element

Data type

Period

onsetString

string

There are no (further) constraints on this element

Data type

string

note

0..*

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

Extensions

Verwandtschaftsgrad

Name: Verwandtschaftsgrad
Definition: Extension erlaubt die Angabe eines Verwandtschaftsgrades zwischen Patient und Familienangehörigen.
url: https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-mol-gen-verwandtschaftsgrad

Snapshot

MII_EX_MolGen_Verwandtschaftsgrad (Extension)	C		Extension	Element id Extension Short description MII EX Mol Gen Verwandtschaftsgrad Definition Extension erlaubt die Angabe eines Verwandtschaftsgrades zwischen Patient und Familienangehörigen. Data type Extension 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())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.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
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Extension.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
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsgrad Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding MII_VS_MolGen_Verwandtschaftsgrad (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCoding			Coding	Data type Coding

Verwandtschaftsverhältnis

Name: Verwandtschaftsverhältnis
Definition: Extension erlaubt die Angabe eines Verwandtschaftsverhältnisses zwischen Patient und Familienangehörigen.
url: https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsverhaeltnis

Snapshot

MII_EX_MolGen_Verwandtschaftsverhaeltnis (Extension)	C		Extension	Element id Extension Short description MII EX MolGen Verwandtschaftsverhaeltnis Definition Extension erlaubt die Angabe eines Verwandtschaftsverhältnisses zwischen Patient und Familienangehörigen. Data type Extension 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())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.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
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Extension.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
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsverhaeltnis Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding MII_VS_MolGen_Verwandtsverhaeltnis (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCoding			Coding	Data type Coding

Familiäre Linie

Name: Familiäre Linie
Definition: Extension erlaubt die Angabe der familiären Linie zwischen Patient und Familienangehörigen.
url: https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-familiare-linie

Snapshot

MII_EX_MolGen_FamiliareLinie (Extension)	C		Extension	Element id Extension Short description MII EX MolGen Familiare Linie Definition Extension erlaubt die Angabe der familiären Linie zwischen Patient und Familienangehörigen. Data type Extension 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())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.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
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Extension.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
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-familiare-linie Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding MII_VS_MolGen_FamiliaereLinie (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCoding			Coding	Data type Coding

FHIR-Element	Logischer Datensatz
FamilyMemberHistory	Anforderung.Indikation.Krankengeschichte Familie

Suchparameter

Folgende Suchparameter sind für das Modul Pathologie-Befund relevant, auch in Kombination:

Der Suchparameter _id MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?_id=1234

Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "_profile" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?_profile=https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/familienanamnese

Anwendungshinweise: Weitere Informationen zur Suche nach "_profile" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "code" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?code=http://snomed.info/sct|830150003

Anwendungshinweise: Weitere Informationen zur Suche nach "code" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter "date" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?date=2022-04-07

Anwendungshinweise: Weitere Informationen zur Suche nach "date" finden sich in der FHIR-Basisspezifikation - Abschnitt "date".
Der Suchparameter "patient" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?patient=Patient/example-mii-molgen-patient-2

Anwendungshinweise: Weitere Informationen zur Suche nach "patient" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".
Der Suchparameter "relationship" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?relationship=http://snomed.info/sct|72705000

Anwendungshinweise: Weitere Informationen zur Suche nach "relationship" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter "sex" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?sex=http://hl7.org/fhir/administrative-gender|female

Anwendungshinweise: Weitere Informationen zur Suche nach "sex" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter "status" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?status=completed

Anwendungshinweise: Weitere Informationen zur Suche nach "status" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter "reason-code" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?reason-code=http://snomed.info/sct|447886005

Anwendungshinweise: Weitere Informationen zur Suche nach "reason-code" finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter "reason-reference" MUSS unterstützt werden:

Beispiele:

GET [base]/FamilyMemberHistory?reason-reference=Observation/12345

Anwendungshinweise: Weitere Informationen zur Suche nach "reason-reference" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".

Examples

Command 'json' could not render: File not found for 'subject=example-mii-molgen-family-member-history-1'

{

"resourceType": "FamilyMemberHistory",

"id": "mii-exa-molgen-family-member-history-2",

"meta": {

"profile": [

"https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/familienanamnese"

]

"relationship": {

"coding": [

{

"system": "http://snomed.info/sct",
"extension": [
{
"url": "https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsgrad",
"valueCoding": {
"code": "699110007",
"system": "http://snomed.info/sct",
"display": "Second degree blood relative (person)"
}
},
{
"url": "https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-verwandtschaftsverhaeltnis",
"valueCoding": {
"code": "17945006",
"system": "http://snomed.info/sct",
"display": "Natural grandmother (person)"
}
},
{
"url": "https://www.medizininformatik-initiative.de/fhir/ext/modul-molgen/StructureDefinition/mii-ex-molgen-familiare-linie",
"valueCoding": {
"code": "66839005",
"system": "http://snomed.info/sct",
"display": "Father (person)"
}
}
],
"code": "394858009",
"display": "Paternal grandmother (person)"

{

"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "PGRMTH",
"display": "paternal grandmother"

}

]

"status": "completed",

"patient": {

"reference": "Patient/mii-exa-molgen-patient"

"date": "2022-11-08",

"sex": {

"coding": [

{

"code": "female",

"system": "http://hl7.org/fhir/administrative-gender"

{

"code": "248152002",
"system": "http://snomed.info/sct",
"display": "Female (finding)"

}

]

"deceasedBoolean": true

}