MedNet interface implementation guide
0.20.0 - CI Build
MedNet interface implementation guide
0.20.0 - CI Build
MedNet interface implementation guide - Downloaded Version 0.20.0 See the Directory of published versions
| Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-humanName | Version: 0.20.0 | |||
| Active as of 2025-12-19 | Computable Name: MNIHumanName | |||
Copyright/Legal: novcom AG |
||||
MedNet Interface (MNI) - Human Name Profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4 |
  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') |
   Slices for extension |
Content/Rules for all slices | |||
   extension:ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required) | |
| 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 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required) | |
| 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 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:salutationandtitle |
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) | |
 suffix |
SΣ | 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HumanName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HumanName |
CHCoreHumanName | |||
| 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 Filter: |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4 |
| 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 | |
| extension:ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required) | |
| 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 | |
| extension:ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required) | |
| 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 | |
| extension:salutationandtitle |
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) | |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HumanName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CHCoreHumanName
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4 |
| 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') |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required) | |
| 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 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required) | |
| 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 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:salutationandtitle |
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) | |
| suffix |
SΣ | 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HumanName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from CHCoreHumanName
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HumanName |
CHCoreHumanName | |||
| 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 Filter: |
|---|---|---|---|---|
| HumanName |
C | 0..* | CHCoreHumanName | Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4 |
| 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 | |
| extension:ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required) | |
| 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 | |
| extension:ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required) | |
| 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 | |
| extension:salutationandtitle |
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) | |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HumanName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CHCoreHumanName
Other representations of profile: CSV, Excel, Schematron