MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - Patient

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-patient Version: 0.16.0
Active as of 2024-11-27 Computable Name: MNIPatient

Copyright/Legal: novcom AG

MedNet Interface (MNI) - Patient Profile

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code
.... identifier:AHVN13 SΣ 0..1 Identifier AHVN13 / NAVS13
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value SΣ 1..1 string AHVN13 / NAVS13 of the patient (13 digits starting ith 756)
Example General: 123456
.... identifier:LocalPid SΣ 0..1 Identifier Local patient identifiers
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... coding SΣ 1..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display SΣ 0..1 string Representation defined by the system
Fixed Value: Medical record number
..... system SΣ 0..1 uri Uri that defines the Software that delivers the Patient ID. If possible this uri should be unique for each Patient database for example https://mysoftware.ch/patientDB/123456
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SC 0..* MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address S 0..* MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:international SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
...... code SΣ 1..1 code Authorized values : S (Never Married) | M (Married) | W (Widowed) | D (Divorced) | U (unmarried) | T (Domestic partner) | L (Legally Separated) | A (Annulled) | I (Interlocutory) | P (Polygamous) | C (Common Law)
...... display SΣ 0..1 string Authorized values : Never Married (S) | Married (M) | Widowed (W) | Divorced (D) | unmarried (U) | Domestic partner (T) | Legally Separated (L) | Annulled (A) | Interlocutory (I)) | Polygamous (P)) | Common Law (C)
..... coding:swiss SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus
...... code SΣ 1..1 code Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown)
...... display SΣ 0..1 string Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9).
... photo S 0..* Attachment currently ignored by MedNet, but could be implemented in the future
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... data S 0..1 base64Binary Data inline, base64ed
.... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
... Slices for contact Content/Rules for all slices
.... contact:MNIContact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for relationship S 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


...... relationship:KIND S 0..1 CodeableConcept Kind of relation ship, for example Emergency contact, Employer
Binding: PatientContactRelationship (required)
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
........ code SΣ 1..1 code C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown)
........ display SΣ 0..1 string Representation defined by the system
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
...... relationship:FamilyMember S 0..1 CodeableConcept FamilyMember relation ship, for example sister
Binding: FamilyMember (required)
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ code SΣ 1..1 code CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ...
........ display SΣ 0..1 string Representation defined by the system
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
..... name SC 0..1 MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
..... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
..... address S 0..1 MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender S 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization SC 0..1 Reference(MedNet Interface (MNI) - Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... preferred S 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(MedNet Interface (MNI) - PractitionerRole) Patient's nominated primary care provider. We allow multiple general practitioner, since gynecologist can also be listed as general practitioner
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:AHVN13.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusrequiredChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.photo.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Patient.contact:MNIContact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:KINDrequiredPatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:FamilyMemberrequiredFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
Patient.contact:MNIContact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-core-hm-1errorPatient.name, Patient.contact:MNIContact.nameif 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-2errorPatient.name, Patient.contact:MNIContact.nameif 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-3errorPatient.name, Patient.contact:MNIContact.namech-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-4errorPatient.name, Patient.contact:MNIContact.namech-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()
ch-pat-3errorPatient.extension:citizenshipISO Country Alpha-2 or ISO Country Alpha-3 code
: (extension.where(url='code').value.coding.code.length()=2 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or (extension.where(url='code').value.coding.code.length()=3 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
cpt-2errorPatient.telecom, Patient.contact:MNIContact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact:MNIContactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... identifier:AHVN13 S 0..1 Identifier AHVN13 / NAVS13
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value S 1..1 string AHVN13 / NAVS13 of the patient (13 digits starting ith 756)
.... identifier:LocalPid S 0..1 Identifier Local patient identifiers
..... type S 1..1 CodeableConcept Description of identifier
...... coding S 1..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display S 0..1 string Representation defined by the system
Fixed Value: Medical record number
..... system S 0..1 uri Uri that defines the Software that delivers the Patient ID. If possible this uri should be unique for each Patient database for example https://mysoftware.ch/patientDB/123456
..... value S 1..1 string The value that is unique
... name S 0..* MNIHumanName Name of a human - parts and usage
... telecom S 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date of birth for the individual
... address S 0..* MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:international S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
...... code S 1..1 code Authorized values : S (Never Married) | M (Married) | W (Widowed) | D (Divorced) | U (unmarried) | T (Domestic partner) | L (Legally Separated) | A (Annulled) | I (Interlocutory) | P (Polygamous) | C (Common Law)
...... display S 0..1 string Authorized values : Never Married (S) | Married (M) | Widowed (W) | Divorced (D) | unmarried (U) | Domestic partner (T) | Legally Separated (L) | Annulled (A) | Interlocutory (I)) | Polygamous (P)) | Common Law (C)
..... coding:swiss S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus
...... code S 1..1 code Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown)
...... display S 0..1 string Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9).
... photo S 0..* Attachment currently ignored by MedNet, but could be implemented in the future
.... contentType S 1..1 code Mime type of the content, with charset etc.
.... data S 0..1 base64Binary Data inline, base64ed
.... url S 0..1 url Uri where the data can be found
.... size S 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
... Slices for contact Content/Rules for all slices
.... contact:MNIContact S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for relationship S 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system, value:coding.code
...... relationship:KIND S 0..1 CodeableConcept Kind of relation ship, for example Emergency contact, Employer
Binding: PatientContactRelationship (required)
....... coding S 0..* Coding Code defined by a terminology system
........ system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
........ code S 1..1 code C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown)
........ display S 0..1 string Representation defined by the system
....... text S 0..1 string If the relationship can not be coded, it can be described in plain text in this field
...... relationship:FamilyMember S 0..1 CodeableConcept FamilyMember relation ship, for example sister
Binding: FamilyMember (required)
....... coding S 0..* Coding Code defined by a terminology system
........ system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ code S 1..1 code CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ...
........ display S 0..1 string Representation defined by the system
....... text S 0..1 string If the relationship can not be coded, it can be described in plain text in this field
..... name S 0..1 MNIHumanName Name of a human - parts and usage
..... telecom S 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
..... address S 0..1 MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender S 0..1 code male | female | other | unknown
..... organization S 0..1 Reference(MedNet Interface (MNI) - Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
..... coding S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... preferred S 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(MedNet Interface (MNI) - PractitionerRole) Patient's nominated primary care provider. We allow multiple general practitioner, since gynecologist can also be listed as general practitioner

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.maritalStatusrequiredChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact:MNIContact.relationship:KINDrequiredPatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:FamilyMemberrequiredFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember

Constraints

IdGradePath(s)DetailsRequirements
ch-pat-3errorPatient.extension:citizenshipISO Country Alpha-2 or ISO Country Alpha-3 code
: (extension.where(url='code').value.coding.code.length()=2 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or (extension.where(url='code').value.coding.code.length()=3 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code
.... identifier:AHVN13 SΣ 0..1 Identifier AHVN13 / NAVS13
..... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value SΣ 1..1 string AHVN13 / NAVS13 of the patient (13 digits starting ith 756)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:LocalPid SΣ 0..1 Identifier Local patient identifiers
..... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display SΣ 0..1 string Representation defined by the system
Fixed Value: Medical record number
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 0..1 uri Uri that defines the Software that delivers the Patient ID. If possible this uri should be unique for each Patient database for example https://mysoftware.ch/patientDB/123456
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SC 0..* MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address S 0..* MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:international SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Authorized values : S (Never Married) | M (Married) | W (Widowed) | D (Divorced) | U (unmarried) | T (Domestic partner) | L (Legally Separated) | A (Annulled) | I (Interlocutory) | P (Polygamous) | C (Common Law)
...... display SΣ 0..1 string Authorized values : Never Married (S) | Married (M) | Widowed (W) | Divorced (D) | unmarried (U) | Domestic partner (T) | Legally Separated (L) | Annulled (A) | Interlocutory (I)) | Polygamous (P)) | Common Law (C)
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:swiss SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown)
...... display SΣ 0..1 string Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9).
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo S 0..* Attachment currently ignored by MedNet, but could be implemented in the future
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data S 0..1 base64Binary Data inline, base64ed
.... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
... Slices for contact Content/Rules for all slices
.... contact:MNIContact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for relationship S 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


...... relationship:KIND S 0..1 CodeableConcept Kind of relation ship, for example Emergency contact, Employer
Binding: PatientContactRelationship (required)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding SΣ 0..* Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown)
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
...... relationship:FamilyMember S 0..1 CodeableConcept FamilyMember relation ship, for example sister
Binding: FamilyMember (required)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding SΣ 0..* Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 1..1 code CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ...
........ display SΣ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
..... name SC 0..1 MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
..... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
..... address S 0..1 MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender S 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization SC 0..1 Reference(MedNet Interface (MNI) - Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... preferred S 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(MedNet Interface (MNI) - PractitionerRole) Patient's nominated primary care provider. We allow multiple general practitioner, since gynecologist can also be listed as general practitioner
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier:AHVN13.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:AHVN13.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusrequiredChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.photo.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Patient.photo.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.contact:MNIContact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:KINDrequiredPatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:FamilyMemberrequiredFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
Patient.contact:MNIContact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-core-hm-1errorPatient.name, Patient.contact:MNIContact.nameif 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-2errorPatient.name, Patient.contact:MNIContact.nameif 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-3errorPatient.name, Patient.contact:MNIContact.namech-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-4errorPatient.name, Patient.contact:MNIContact.namech-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()
ch-pat-3errorPatient.extension:citizenshipISO Country Alpha-2 or ISO Country Alpha-3 code
: (extension.where(url='code').value.coding.code.length()=2 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or (extension.where(url='code').value.coding.code.length()=3 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
cpt-2errorPatient.telecom, Patient.contact:MNIContact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact:MNIContactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(19 nested mandatory elements)
Must-Support: 63 elements
Fixed: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 3 is sliced based on the values of Patient.identifier
  • The element 2 is sliced based on the values of Patient.maritalStatus.coding
  • The element 2 is sliced based on the values of Patient.contact.relationship

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code
.... identifier:AHVN13 SΣ 0..1 Identifier AHVN13 / NAVS13
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value SΣ 1..1 string AHVN13 / NAVS13 of the patient (13 digits starting ith 756)
Example General: 123456
.... identifier:LocalPid SΣ 0..1 Identifier Local patient identifiers
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... coding SΣ 1..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display SΣ 0..1 string Representation defined by the system
Fixed Value: Medical record number
..... system SΣ 0..1 uri Uri that defines the Software that delivers the Patient ID. If possible this uri should be unique for each Patient database for example https://mysoftware.ch/patientDB/123456
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SC 0..* MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address S 0..* MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:international SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
...... code SΣ 1..1 code Authorized values : S (Never Married) | M (Married) | W (Widowed) | D (Divorced) | U (unmarried) | T (Domestic partner) | L (Legally Separated) | A (Annulled) | I (Interlocutory) | P (Polygamous) | C (Common Law)
...... display SΣ 0..1 string Authorized values : Never Married (S) | Married (M) | Widowed (W) | Divorced (D) | unmarried (U) | Domestic partner (T) | Legally Separated (L) | Annulled (A) | Interlocutory (I)) | Polygamous (P)) | Common Law (C)
..... coding:swiss SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus
...... code SΣ 1..1 code Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown)
...... display SΣ 0..1 string Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9).
... photo S 0..* Attachment currently ignored by MedNet, but could be implemented in the future
.... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... data S 0..1 base64Binary Data inline, base64ed
.... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
... Slices for contact Content/Rules for all slices
.... contact:MNIContact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for relationship S 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


...... relationship:KIND S 0..1 CodeableConcept Kind of relation ship, for example Emergency contact, Employer
Binding: PatientContactRelationship (required)
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
........ code SΣ 1..1 code C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown)
........ display SΣ 0..1 string Representation defined by the system
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
...... relationship:FamilyMember S 0..1 CodeableConcept FamilyMember relation ship, for example sister
Binding: FamilyMember (required)
....... coding SΣ 0..* Coding Code defined by a terminology system
........ system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ code SΣ 1..1 code CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ...
........ display SΣ 0..1 string Representation defined by the system
....... text SΣ 0..1 string If the relationship can not be coded, it can be described in plain text in this field
..... name SC 0..1 MNIHumanName Name of a human - parts and usage
ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official
ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden
ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name
ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
..... telecom SC 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
..... address S 0..1 MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender S 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization SC 0..1 Reference(MedNet Interface (MNI) - Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
..... coding SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
.... preferred S 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(MedNet Interface (MNI) - PractitionerRole) Patient's nominated primary care provider. We allow multiple general practitioner, since gynecologist can also be listed as general practitioner
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:AHVN13.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:LocalPid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:LocalPid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusrequiredChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.photo.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Patient.contact:MNIContact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:KINDrequiredPatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:FamilyMemberrequiredFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
Patient.contact:MNIContact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-core-hm-1errorPatient.name, Patient.contact:MNIContact.nameif 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-2errorPatient.name, Patient.contact:MNIContact.nameif 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-3errorPatient.name, Patient.contact:MNIContact.namech-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-4errorPatient.name, Patient.contact:MNIContact.namech-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()
ch-pat-3errorPatient.extension:citizenshipISO Country Alpha-2 or ISO Country Alpha-3 code
: (extension.where(url='code').value.coding.code.length()=2 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or (extension.where(url='code').value.coding.code.length()=3 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
cpt-2errorPatient.telecom, Patient.contact:MNIContact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contact:MNIContactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
.... identifier:AHVN13 S 0..1 Identifier AHVN13 / NAVS13
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.32
..... value S 1..1 string AHVN13 / NAVS13 of the patient (13 digits starting ith 756)
.... identifier:LocalPid S 0..1 Identifier Local patient identifiers
..... type S 1..1 CodeableConcept Description of identifier
...... coding S 1..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display S 0..1 string Representation defined by the system
Fixed Value: Medical record number
..... system S 0..1 uri Uri that defines the Software that delivers the Patient ID. If possible this uri should be unique for each Patient database for example https://mysoftware.ch/patientDB/123456
..... value S 1..1 string The value that is unique
... name S 0..* MNIHumanName Name of a human - parts and usage
... telecom S 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date of birth for the individual
... address S 0..* MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: ChCoreMaritalStatus (required)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:international S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
...... code S 1..1 code Authorized values : S (Never Married) | M (Married) | W (Widowed) | D (Divorced) | U (unmarried) | T (Domestic partner) | L (Legally Separated) | A (Annulled) | I (Interlocutory) | P (Polygamous) | C (Common Law)
...... display S 0..1 string Authorized values : Never Married (S) | Married (M) | Widowed (W) | Divorced (D) | unmarried (U) | Domestic partner (T) | Legally Separated (L) | Annulled (A) | Interlocutory (I)) | Polygamous (P)) | Common Law (C)
..... coding:swiss S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus
...... code S 1..1 code Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown)
...... display S 0..1 string Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9).
... photo S 0..* Attachment currently ignored by MedNet, but could be implemented in the future
.... contentType S 1..1 code Mime type of the content, with charset etc.
.... data S 0..1 base64Binary Data inline, base64ed
.... url S 0..1 url Uri where the data can be found
.... size S 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
... Slices for contact Content/Rules for all slices
.... contact:MNIContact S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... Slices for relationship S 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system, value:coding.code
...... relationship:KIND S 0..1 CodeableConcept Kind of relation ship, for example Emergency contact, Employer
Binding: PatientContactRelationship (required)
....... coding S 0..* Coding Code defined by a terminology system
........ system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
........ code S 1..1 code C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown)
........ display S 0..1 string Representation defined by the system
....... text S 0..1 string If the relationship can not be coded, it can be described in plain text in this field
...... relationship:FamilyMember S 0..1 CodeableConcept FamilyMember relation ship, for example sister
Binding: FamilyMember (required)
....... coding S 0..* Coding Code defined by a terminology system
........ system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ code S 1..1 code CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ...
........ display S 0..1 string Representation defined by the system
....... text S 0..1 string If the relationship can not be coded, it can be described in plain text in this field
..... name S 0..1 MNIHumanName Name of a human - parts and usage
..... telecom S 0..* MNIContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
..... address S 0..1 MNIAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
..... gender S 0..1 code male | female | other | unknown
..... organization S 0..1 Reference(MedNet Interface (MNI) - Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
..... coding S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:ietf:bcp:47
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
.... preferred S 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(MedNet Interface (MNI) - PractitionerRole) Patient's nominated primary care provider. We allow multiple general practitioner, since gynecologist can also be listed as general practitioner

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.maritalStatusrequiredChCoreMaritalStatus
http://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus
Patient.contact:MNIContact.relationship:KINDrequiredPatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:MNIContact.relationship:FamilyMemberrequiredFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember

Constraints

IdGradePath(s)DetailsRequirements
ch-pat-3errorPatient.extension:citizenshipISO Country Alpha-2 or ISO Country Alpha-3 code
: (extension.where(url='code').value.coding.code.length()=2 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or (extension.where(url='code').value.coding.code.length()=3 and extension.where(url='code').value.coding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient MedNet Interface (MNI) - Patient
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained S 0..* Resource It is possible to include the generalPractitioner or a contact organization as embedded resource in this contained object. This way it is not needed to include it in the Bundle
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... citizenship SC 0..* (Complex) Citizenship(s) of patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ch-pat-3: ISO Country Alpha-2 or ISO Country Alpha-3 code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code