MedNet interface implementation guide
0.15.0 - CI Build
MedNet interface implementation guide
0.15.0 - CI Build
MedNet interface implementation guide - Local Development build (v0.15.0). See the Directory of published versions
| Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-humanName | Version: 0.15.0 | |||
| Active as of 2022-06-13 | Computable Name: MNIHumanName | |||
Copyright/Legal: novcom AG |
||||
MedNet Interface (MNI) - Human Name Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreHumanName
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HumanName | 0..* | CHCoreHumanName | Name of a human - parts and usage | |
 use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
| text | S | 0..1 | string | In case the name could not be divided in firstname, lastname, this field could be used to contain a non structured name value |
| family | S | 0..1 | string | Family name (often called 'Surname') |
| given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
| prefix | S | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. |
 suffix | S | 0..* | string | Parts that come after the name |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | I | 0..* | CHCoreHumanName | Name of a human - parts and usage |
 id | 0..1 | string | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | SΣ | 0..1 | string | In case the name could not be divided in firstname, lastname, this field could be used to contain a non structured name value |
 family | SΣ | 0..1 | string | Family name (often called 'Surname') |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ch-ext-ech-11-name | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ch-ext-ech-11-firstname | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| prefix | SΣ | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-EN-qualifier | 0..* | code | For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
 period | Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | I | 0..* | CHCoreHumanName | Name of a human - parts and usage |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | Σ | 0..1 | string | In case the name could not be divided in firstname, lastname, this field could be used to contain a non structured name value |
| family | Σ | 0..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| Documentation for this format | ||||
This structure is derived from CHCoreHumanName
Differential View
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | 0..* | CHCoreHumanName | Name of a human - parts and usage | |
| use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
| text | S | 0..1 | string | In case the name could not be divided in firstname, lastname, this field could be used to contain a non structured name value |
| family | S | 0..1 | string | Family name (often called 'Surname') |
| given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
| prefix | S | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. |
| suffix | S | 0..* | string | Parts that come after the name |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HumanName | I | 0..* | CHCoreHumanName | Name of a human - parts and usage |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | SΣ | 0..1 | string | In case the name could not be divided in firstname, lastname, this field could be used to contain a non structured name value |
| family | SΣ | 0..1 | string | Family name (often called 'Surname') |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ch-ext-ech-11-name | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ch-ext-ech-11-firstname | 0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required): A set of codes advising a system or user which name in a set of names to select for a given purpose. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| prefix | SΣ | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-EN-qualifier | 0..* | code | For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| HumanName.use | required | NameUse |
| Id | Grade | Path | Details | Requirements |
| ele-1 | error | HumanName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ch-core-hm-1 | error | HumanName | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official') | |
| ch-core-hm-2 | error | HumanName | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden')) | |
| ch-core-hm-3 | error | HumanName | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
| ch-core-hm-4 | error | HumanName | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
| ele-1 | error | HumanName.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.family.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.family.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.family.extension:ech11name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.family.extension:ech11name | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.given.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.given.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.given.extension:ech11firstname | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.given.extension:ech11firstname | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.prefix.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.prefix.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.prefix.extension:salutationandtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | HumanName.prefix.extension:salutationandtitle | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | HumanName.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | HumanName.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |