MedNet interface implementation guide
0.16.0 - CI Build
Publication Build: This will be filled in by the publication tooling
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |||||
![]() ![]() ![]() |
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.) | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | AHVN13 / NAVS13 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | AHVN13 / NAVS13 of the patient (13 digits starting ith 756) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Local patient identifiers | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system Fixed Value: Medical record number | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
S | 0..* | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9). | ||||
![]() ![]() ![]() |
S | 0..* | Attachment | currently ignored by MedNet, but could be implemented in the future | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of relation ship, for example Emergency contact, Employer Binding: PatientContactRelationship (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | FamilyMember relation ship, for example sister Binding: FamilyMember (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | Reference(MedNet Interface (MNI) - Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.
| ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:bcp:47 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.identifier:AHVN13.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:LocalPid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:LocalPid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | required | ChCoreMaritalStatushttp://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus | ||||
Patient.photo.contentType | required | Mime 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.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:KIND | required | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:FamilyMember | required | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | ||||
Patient.contact:MNIContact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-core-hm-1 | error | Patient.name, Patient.contact:MNIContact.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name, Patient.contact:MNIContact.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name, Patient.contact:MNIContact.name | 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 | Patient.name, Patient.contact:MNIContact.name | 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() | |
ch-pat-3 | error | Patient.extension:citizenship | ISO 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-2 | error | Patient.telecom, Patient.contact:MNIContact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
pat-1 | error | Patient.contact:MNIContact | SHALL 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |
![]() ![]() ![]() |
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.) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | AHVN13 / NAVS13 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | AHVN13 / NAVS13 of the patient (13 digits starting ith 756) |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Local patient identifiers |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system Fixed Value: Medical record number |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..* | MNIHumanName | Name of a human - parts and usage |
![]() ![]() ![]() |
S | 0..* | MNIContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
S | 0..* | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (required) |
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus |
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9). |
![]() ![]() ![]() |
S | 0..* | Attachment | currently ignored by MedNet, but could be implemented in the future |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
S | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:coding.system, value:coding.code |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of relation ship, for example Emergency contact, Employer Binding: PatientContactRelationship (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | FamilyMember relation ship, for example sister Binding: FamilyMember (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIHumanName | Name of a human - parts and usage |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | MNIContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(MedNet Interface (MNI) - Organization) | Organization that is associated with the contact |
![]() ![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:bcp:47 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | required | ChCoreMaritalStatushttp://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus | |
Patient.contact:MNIContact.relationship:KIND | required | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact:MNIContact.relationship:FamilyMember | required | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember |
Id | Grade | Path(s) | Details | Requirements |
ch-pat-3 | error | Patient.extension:citizenship | ISO 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')) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |||||
![]() ![]() ![]() |
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.) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | AHVN13 / NAVS13 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | AHVN13 / NAVS13 of the patient (13 digits starting ith 756) Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Local patient identifiers | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system Fixed Value: Medical record number | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
S | 0..* | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
S | 0..* | Attachment | currently ignored by MedNet, but could be implemented in the future | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of relation ship, for example Emergency contact, Employer Binding: PatientContactRelationship (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | FamilyMember relation ship, for example sister Binding: FamilyMember (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | Reference(MedNet Interface (MNI) - Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.
| ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:bcp:47 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:AHVN13.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:AHVN13.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:LocalPid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:LocalPid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | required | ChCoreMaritalStatushttp://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus | ||||
Patient.photo.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Patient.photo.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:KIND | required | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:FamilyMember | required | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | ||||
Patient.contact:MNIContact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-core-hm-1 | error | Patient.name, Patient.contact:MNIContact.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name, Patient.contact:MNIContact.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name, Patient.contact:MNIContact.name | 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 | Patient.name, Patient.contact:MNIContact.name | 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() | |
ch-pat-3 | error | Patient.extension:citizenship | ISO 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-2 | error | Patient.telecom, Patient.contact:MNIContact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
pat-1 | error | Patient.contact:MNIContact | SHALL 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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |||||
![]() ![]() ![]() |
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.) | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | AHVN13 / NAVS13 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | AHVN13 / NAVS13 of the patient (13 digits starting ith 756) Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Local patient identifiers | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system Fixed Value: Medical record number | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
S | 0..* | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9). | ||||
![]() ![]() ![]() |
S | 0..* | Attachment | currently ignored by MedNet, but could be implemented in the future | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of relation ship, for example Emergency contact, Employer Binding: PatientContactRelationship (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | FamilyMember relation ship, for example sister Binding: FamilyMember (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | Reference(MedNet Interface (MNI) - Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.
| ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:bcp:47 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Patient.identifier:AHVN13.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:LocalPid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:LocalPid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | required | ChCoreMaritalStatushttp://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus | ||||
Patient.photo.contentType | required | Mime 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.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:KIND | required | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact:MNIContact.relationship:FamilyMember | required | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | ||||
Patient.contact:MNIContact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-core-hm-1 | error | Patient.name, Patient.contact:MNIContact.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official') | |
ch-core-hm-2 | error | Patient.name, Patient.contact:MNIContact.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden')) | |
ch-core-hm-3 | error | Patient.name, Patient.contact:MNIContact.name | 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 | Patient.name, Patient.contact:MNIContact.name | 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() | |
ch-pat-3 | error | Patient.extension:citizenship | ISO 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-2 | error | Patient.telecom, Patient.contact:MNIContact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
pat-1 | error | Patient.contact:MNIContact | SHALL 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |
![]() ![]() ![]() |
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.) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | AHVN13 / NAVS13 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.32 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | AHVN13 / NAVS13 of the patient (13 digits starting ith 756) |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Local patient identifiers |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system Fixed Value: Medical record number |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..* | MNIHumanName | Name of a human - parts and usage |
![]() ![]() ![]() |
S | 0..* | MNIContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
S | 0..* | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ChCoreMaritalStatus (required) |
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus |
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.ch/ig/ch-core/CodeSystem/ech-11-maritalstatus |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Authorized values : 1 (Unmarried) | 2 (Married) | 3 (Widowed) | 4 (Divorced) | 5 (Unmarried) | 6 (Domestic partner) | 7 (Legally Separated) | 9 (Unknown) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Authorized values : Unmarried (1) | Married (2) | Widowed (3) | Divorced (4) | Unmarried (5) | Domestic partner (6) | Legally Separated (7) | Unknown (9). |
![]() ![]() ![]() |
S | 0..* | Attachment | currently ignored by MedNet, but could be implemented in the future |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
S | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:coding.system, value:coding.code |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of relation ship, for example Emergency contact, Employer Binding: PatientContactRelationship (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | C (Emergency Contact) | E (Employer) | F (Federal Agency) | I (Insurance Company) | N (Next-of-Kin) | S (State Agency) | U (Unknown) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | FamilyMember relation ship, for example sister Binding: FamilyMember (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | CHILD (child) | DAU (natural daugher) | SON (natural son) | FTH (father) | MTH (mother) | ... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If the relationship can not be coded, it can be described in plain text in this field |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIHumanName | Name of a human - parts and usage |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | MNIContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | MNIAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(MedNet Interface (MNI) - Organization) | Organization that is associated with the contact |
![]() ![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:bcp:47 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | required | ChCoreMaritalStatushttp://fhir.ch/ig/ch-core/ValueSet/ch-core-maritalstatus | |
Patient.contact:MNIContact.relationship:KIND | required | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact:MNIContact.relationship:FamilyMember | required | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember |
Id | Grade | Path(s) | Details | Requirements |
ch-pat-3 | error | Patient.extension:citizenship | ISO 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
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | MedNet Interface (MNI) - Patient | |||||
![]() ![]() ![]() |
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.) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system, value:type.coding.system, value:type.coding.code | ||||