MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR Patient

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-patient-core
Version:1.4.1
Name:MRPatient
Title:MR Patient
Status:Active as of 2024-10-28 02:34:31+0000
Definition:

MediRecords core Patient profile representing identity, demographic and contacts details of an individual within the context of health care or other health-related services supported within MediRecords

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-patient-core

Formal Views of Profile Content

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

This structure is derived from AUBasePatient

Summary

Mandatory: 7 elements (39 nested mandatory elements)
Must-Support: 67 elements
Fixed Value: 19 elements
Prohibited: 2 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 Patient.identifier is sliced based on the value of pattern:type
  • The element Patient.name is sliced based on the value of value:use (Closed)
  • The element Patient.telecom is sliced based on the values of value:use, value:system (Closed)
  • The element Patient.contact.relationship is sliced based on the value of value:coding.system (Closed)
  • The element Patient.contact.telecom is sliced based on the value of value:system (Closed)

This structure is derived from AUBasePatient

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Patient C0..*AUBasePatientA patient in an Australian healthcare context
inv-mr-pat-contact-nok-emergency-01: Can only specify one each of Emergency Contact or Next of Kin
​... meta
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... extension:birthPlace S0..1PatBirthPlaceRepresents the place of birth for patient with atsi status (Indigenous status). This field is only set when the atsi status is 1, 2 or 3.
​.... valueAddress 1..1AddressValue of extension
​..... text S0..1stringText representation of the address
Max Length: 100
​... extension:indigenousStatus S0..1AustralianIndigenousStatusIndigenous status
​... ctgCoPaymentRelief S0..1booleanRepresents whether the patient with atsi status (Indigenous status) is eligible for ctg co payment relief. This field is only set when the atsi status is 1, 2 or 3.
URL: https://fhir.medirecords.com/StructureDefinition/mr-ctg-copayment-relief-extn
​... languageSpokenAtHome S0..1CodeableConceptRepresents the language spoken at home for patient with atsi status (Indigenous status). This field is only set when the atsi status is 1, 2 or 3.
URL: https://fhir.medirecords.com/StructureDefinition/mr-language-at-home-extn
Binding: MediRecords Language Code ValueSet (required)
​... englishAsSecondLanguageInd S0..1booleanEnglish As Second Language Indicator Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn
​... ethnicity S0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
.... extension 0..0
​.... valueCodeableConcept 1..1CodeableConceptCoded ethnicity
Binding: MediRecords Patient Ethnicity ValueSet (required)
​... importance S0..1CodeableConceptSpecial status given the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-importance
Binding: PatientImportance (example)
​.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: MediRecords Patient Importance ValueSet (required)
​... patient-note S0..1stringPatient demographic notes
URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext
​... Slices for identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberPatient's Identifier. Note: The request payload may contain value for only one of the below three fields AUCwlthSeniorsHealthCardNumber, AUHealthCareCardNumber and AUPensionerConcessionCardNumber. If the payload has more than one of these three fields, then it will be rejected
Slice: Unordered, Open by pattern:type
​.... identifier:identifierPT S0..1Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberExternal Patient Number (PT)
​..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PT
​..... system 0..1uriTenant identifier hosting the external patient number in the form 'urn:uuid:<<tenant-guid>>'. The value is ignored in write operations.
​..... value S1..1stringExternal Patient Number
​.... identifier:identifierIHI S0..1AUIHIIndividual Healthcare Identifier (IHI)
​.... identifier:identifierMRN S0..*AUMedicalRecordNumberMedical Record Number (MRN)
​.... identifier:identifierMCN S0..1AUMedicareCardNumberMedicare Card Number
​..... value C1..1stringMedicare card number
inv-mr-pat-ind-mcn-value-01: Medicare Card Number must be of 11 digits
​..... period
​...... end C0..1dateTimeMedicare card expiry date
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
​.... identifier:identifierDVA S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
​.... identifier:identifierPCCN S0..1AUPensionerConcessionCardNumberPensioner Concession Card Number
​..... period
​...... end C0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
​.... identifier:identifierHCN S0..1AUHealthCareCardNumberHealth Care Card Number
​..... period
​...... end C0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
​.... identifier:identifierSHCN S0..1AUCwlthSeniorsHealthCardNumberCommonwealth Seniors Health Card Number
​..... period
​...... end C0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
​.... identifier:identifierINS S0..*AUInsuranceMemberNumberInsurance Member Number
​..... value 1..1stringInsurance member number
Max Length: 15
​..... period
​...... end C0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
​..... assigner
​...... reference S1..1stringReference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API.
​... active S0..1booleanWhether this patient's record is in active use
​... Slices for name 1..*HumanNameA name associated with the patient
Slice: Unordered, Closed by value:use
​.... name:officialName S1..1HumanNameRepresents the patient official name.
​..... use S1..1codeofficial
Fixed Value: official
​..... family S1..1stringLast Name
Max Length: 40
​..... given S0..2stringFirst Name and Middle Name as separate occurences
Max Length: 40
​..... prefix S0..1stringName Title. Must match a value allowed within the MediRecords TitleID lookup list.
​.... name:preferredName S0..1HumanNameRepresents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name.
​..... use 1..1codeusual
Fixed Value: usual
​..... text S0..1stringPreferred Name
Max Length: 40
​.... name:previouslyKnownAs S0..1HumanNameRepresents the patient previously known name. Max 40 characters in length.
​..... use 1..1codeold
Fixed Value: old
​..... text S0..1stringPreviously Known As
Max Length: 40
​..... period S0..1PeriodTime period when name was/is in use
​... Slices for telecom 1..6ContactPointPatient's Contact Method. Primary contact will be determined based on the value provided in 'ContactPoint.rank'. Out of the multiple types of 'telecom', only one can be marked as 'primary' contact by setting the value of 'ContactPoint.rank' to'1'. 'ContactPoint.rank' shall not be populated for the remaining contacts
Slice: Unordered, Closed by value:use, value:system
​.... telecom:personal-email SC0..1ContactPointEmail
inv-mr-pat-telecom-email-value-01: Please Provide a valid email id
​..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
​..... value S1..1stringThe actual contact point details
Max Length: 100
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: home
​.... telecom:homePhone SC0..1ContactPointHome Phone. The number should be of 10 digits length
inv-mr-pat-telecom-home-value-01: Home Phone must be between 8 to 10 digits
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: home
​.... telecom:workPhone SC0..1ContactPointWork Phone. The number should be of 10 digits length
inv-mr-pat-telecom-work-value-01: Work Phone must be between 8 to 10 digits
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:mobile SC0..1ContactPointMobile. The number should be of 10 digits length
inv-mr-pat-telecom-mobile-value-01: Mobile Phone must be between 8 to 10 digits
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
​.... telecom:sms S0..1ContactPointSMS
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: sms
​..... value S1..1stringThe actual contact point details
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
​.... telecom:letter S0..1ContactPointLetter
​..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: other
..... value 0..0
​..... use S1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: home
​... gender S1..1codemale | female | other | unknown
​... birthDate SC1..1dateRepresents the patient's date of birth in the format YYYY-MM-DD. Date of birth should not be in the future
inv-mr-pat-dob-value-01: Date Of Birth must be in YYYY-MM-DD format
​.... extension:accuracyIndicator S0..1DateAccuracyIndicatorMediRecords supports only “AAA - 'Day, month and year are accurate'” or “EEE - 'Day, month and year are estimated'”. Any other value provided in the request will not be supported. By default MediRecords will assume the code is “AAA”.
​... deceasedDateTime S0..1dateTimeRepresents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future.
​... address SC0..2MRAusAddress, MRForeignAddressAn address (Australia/foreign country) for use within an Australian healthcare context. Must indicate if the address is the primary address for use
inv-mr-address-elements-required: For an Address: line, city, state, postalCode and country are all mandatory
​... photo 0..*AttachmentPatient's photo. Only jpg/png format is supported
​... contact
​.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
​.... related-person S0..1Reference(MR RelatedPerson)Reference to RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson profiled by https://fhir.medirecords.com/StructureDefinition/mr-patient-relatedperson-extn
​..... valueReference 1..1Reference()Value of extension
​...... reference 1..1stringLiteral reference, Relative, internal or absolute URL
​.... Slices for relationship 1..*CodeableConceptContact's relationship to patient
Slice: Unordered, Closed by value:coding.system
​..... relationship:contact-type S0..2CodeableConceptPatient contact type
​...... coding 1..1CodingC (Emergency Contact) | N (Next-of-kin)
Binding: MediRecords Patient Contact Type ValueSet (required)
​....... system 1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
​..... relationship:family-relationship S1..2CodeableConceptFAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact.
​...... coding 1..1CodingFAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ...
Binding: MediRecords Family Member Relationship Type ValueSet (extensible)
​....... system 1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
​.... name S1..1HumanNameFull name of contact
​..... use 0..1codeusual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official
​..... text 1..1stringText representation of the full name
​.... Slices for telecom S1..4ContactPointPatient contact's communication numbers/addresses. At least one contact number/address is required.
Slice: Unordered, Closed by value:system
​..... telecom:contact-email S0..1ContactPointcontact's email
​...... system 1..1codeemail
Fixed Value: email
​...... rank 0..1positiveIntPreferred order of use for mode of contact. A contact must have one telecom with rank = 1.
​..... telecom:contact-phone S0..3ContactPointcontact's phone number
​...... system 1..1codephone
Fixed Value: phone
​...... use 1..1codehome | work | mobile
​...... rank 0..1positiveIntPreferred order of use for mode of contact. A contact must have one telecom with rank = 1.
​... generalPractitioner S0..*Reference(MR Practitioner)Use 'MRPractitioner' to represent Usual GP.
​... managingOrganization S0..1Reference(MR Organisation)Represents default practice id where the patient details are created

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*AUBasePatientA patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
inv-mr-pat-contact-nok-emergency-01: Can only specify one each of Emergency Contact or Next of Kin
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace S0..1AddressRepresents the place of birth for patient with atsi status (Indigenous status). This field is only set when the atsi status is 1, 2 or 3.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... Slices for value[x] 1..1AddressValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueAddress 1..1AddressValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Max Length: 100
...... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ0..1stringName of city, town etc.
Example General: Erewhon
...... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... state Σ0..1stringSub-unit of country (abbreviations ok)
...... postalCode Σ0..1stringPostal code for area
Example General: 9132
...... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... indigenousStatus S0..1CodingIndigenous status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
Binding: Australian Indigenous Status . (required)
... closingTheGapRegistration 0..1booleanClosing the Gap co-payment eligibility indicator
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... mothersMaidenName 0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... interpreterRequired 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... dateOfArrival 0..1dateThe date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
... skinCode S0..1CodeableConceptRepresents the skin code for patient with atsi status (Indigenous status). This field is only set when the atsi status is 1, 2 or 3.
URL: https://fhir.medirecords.com/StructureDefinition/mr-skin-extn
Binding: MediRecords ATSI Skin Code ValueSet (required)
... ctgCoPaymentRelief S0..1booleanRepresents whether the patient with atsi status (Indigenous status) is eligible for ctg co payment relief. This field is only set when the atsi status is 1, 2 or 3.
URL: https://fhir.medirecords.com/StructureDefinition/mr-ctg-copayment-relief-extn
... languageSpokenAtHome S0..1CodeableConceptRepresents the language spoken at home for patient with atsi status (Indigenous status). This field is only set when the atsi status is 1, 2 or 3.
URL: https://fhir.medirecords.com/StructureDefinition/mr-language-at-home-extn
Binding: MediRecords Language Code ValueSet (required)
... englishAsSecondLanguageInd S0..1booleanEnglish As Second Language Indicator Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn
... ethnicity S0..*CodeableConceptEthnicity
URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ethnicity"
.... Slices for value[x] 1..1CodeableConceptCoded ethnicity
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptCoded ethnicity
Binding: MediRecords Patient Ethnicity ValueSet (required)
... importance S0..1CodeableConceptSpecial status given the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-importance
Binding: PatientImportance (example)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-importance"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
Binding: PatientImportance (example)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: MediRecords Patient Importance ValueSet (required)
... patient-note S0..1stringPatient demographic notes
URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberPatient's Identifier. Note: The request payload may contain value for only one of the below three fields AUCwlthSeniorsHealthCardNumber, AUHealthCareCardNumber and AUPensionerConcessionCardNumber. If the payload has more than one of these three fields, then it will be rejected
Slice: Unordered, Open by pattern:type
.... identifier:identifierPT S0..1Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberExternal Patient Number (PT)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PT
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriTenant identifier hosting the external patient number in the form 'urn:uuid:<<tenant-guid>>'. The value is ignored in write operations.
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringExternal Patient Number
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:identifierIHI SC0..1AUIHIIndividual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... identifier:identifierMRN S0..*AUMedicalRecordNumberMedical Record Number (MRN)
.... identifier:identifierMCN S0..1AUMedicareCardNumberMedicare Card Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value ΣC1..1stringMedicare card number
inv-mr-pat-ind-mcn-value-01: Medicare Card Number must be of 11 digits
Example General: 123456
Example Medicare card number: 32788511952
Max Length: 11
..... period Σ0..1PeriodTime period when id is/was valid for use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeMedicare card expiry date
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:identifierDVA S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
.... identifier:identifierPCCN S0..1AUPensionerConcessionCardNumberPensioner Concession Card Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value Σ1..1stringCentrelink CRN as displayed on the Pensioner Concession Card
Example General: 123456
Example Centrelink CRN: 307111942H
Max Length: 10
..... period Σ0..1PeriodTime period when id is/was valid for use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:identifierHCN S0..1AUHealthCareCardNumberHealth Care Card Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value Σ1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example General: 123456
Example Centrelink CRN: 307111942H
Max Length: 10
..... period Σ0..1PeriodTime period when id is/was valid for use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:identifierSHCN S0..1AUCwlthSeniorsHealthCardNumberCommonwealth Seniors Health Card Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
..... value Σ1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example General: 123456
Example Centrelink CRN: 307111942H
Max Length: 10
..... period Σ0..1PeriodTime period when id is/was valid for use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:identifierINS S0..*AUInsuranceMemberNumberInsurance Member Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ1..1uriSystem identifier namespace for the insurer that assigned the insurance member number
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringInsurance member number
Example General: 123456
Max Length: 15
..... period Σ0..1PeriodTime period when id is/was valid for use
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC0..1dateTimeStarting time with inclusive boundary
...... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported
..... assigner Σ1..1Reference(Organization)Insurer
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference SΣC1..1stringReference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API.
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringName of insurer
... active ?!SΣ0..1booleanWhether this patient's record is in active use
... Slices for name Σ1..*HumanNameA name associated with the patient
Slice: Unordered, Closed by value:use
.... name:officialName SΣ1..1HumanNameRepresents the patient official name.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeofficial
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family SΣ1..1stringLast Name
Max Length: 40
..... given SΣ0..2stringFirst Name and Middle Name as separate occurences
This repeating element order: Given Names appear in the correct order for presenting the name
Max Length: 40
..... prefix SΣ0..1stringName Title. Must match a value allowed within the MediRecords TitleID lookup list.
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:preferredName SΣ0..1HumanNameRepresents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual
Binding: NameUse (required): The use of a human name.


Fixed Value: usual
..... text SΣ0..1stringPreferred Name
Max Length: 40
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:previouslyKnownAs SΣ0..1HumanNameRepresents the patient previously known name. Max 40 characters in length.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeold
Binding: NameUse (required): The use of a human name.


Fixed Value: old
..... text SΣ0..1stringPreviously Known As
Max Length: 40
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ1..6ContactPointPatient's Contact Method. Primary contact will be determined based on the value provided in 'ContactPoint.rank'. Out of the multiple types of 'telecom', only one can be marked as 'primary' contact by setting the value of 'ContactPoint.rank' to'1'. 'ContactPoint.rank' shall not be populated for the remaining contacts
Slice: Unordered, Closed by value:use, value:system
.... telecom:personal-email SΣC0..1ContactPointEmail
inv-mr-pat-telecom-email-value-01: Please Provide a valid email id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
Max Length: 100
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: home
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:homePhone SΣC0..1ContactPointHome Phone. The number should be of 10 digits length
inv-mr-pat-telecom-home-value-01: Home Phone must be between 8 to 10 digits
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: home
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:workPhone SΣC0..1ContactPointWork Phone. The number should be of 10 digits length
inv-mr-pat-telecom-work-value-01: Work Phone must be between 8 to 10 digits
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:mobile SΣC0..1ContactPointMobile. The number should be of 10 digits length
inv-mr-pat-telecom-mobile-value-01: Mobile Phone must be between 8 to 10 digits
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:sms SΣ0..1ContactPointSMS
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: sms
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:letter SΣ0..1ContactPointLetter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: other
..... use ?!SΣ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: home
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣC1..1dateRepresents the patient's date of birth in the format YYYY-MM-DD. Date of birth should not be in the future
inv-mr-pat-dob-value-01: Date Of Birth must be in YYYY-MM-DD format
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... accuracyIndicator S0..1CodingMediRecords supports only “AAA - 'Day, month and year are accurate'” or “EEE - 'Day, month and year are estimated'”. Any other value provided in the request will not be supported. By default MediRecords will assume the code is “AAA”.
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


.... birthTime 0..1dateTimeBirth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... Slices for deceased[x] ?!Σ0..1dateTimeIndicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedDateTime ?!SΣ0..1dateTimeRepresents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future.
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... accuracyIndicator 0..1CodingDeceased date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
Binding: Date Accuracy Indicator . (required): Date accuracy coding


..... value 0..1dateTimePrimitive value for dateTime
.... deceased[x]:deceasedBoolean ?!Σ0..1booleanDeceased indicator
... address SC0..2MRAusAddress, MRForeignAddressAn address (Australia/foreign country) for use within an Australian healthcare context. Must indicate if the address is the primary address for use
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-mr-address-elements-required: For an Address: line, city, state, postalCode and country are all mandatory
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentPatient's photo. Only jpg/png format is supported
... contact C0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... related-person S0..1Reference(MR RelatedPerson)Reference to RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson profiled by https://fhir.medirecords.com/StructureDefinition/mr-patient-relatedperson-extn
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
..... Slices for value[x] 1..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 1..1Reference()Value of extension
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for relationship 1..*CodeableConceptContact's relationship to patient
Slice: Unordered, Closed by value:coding.system
Binding: Contact Relationship Type . (extensible)
..... relationship:contact-type S0..2CodeableConceptPatient contact type
Binding: Contact Relationship Type . (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingC (Emergency Contact) | N (Next-of-kin)
Binding: MediRecords Patient Contact Type ValueSet (required)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... relationship:family-relationship S1..2CodeableConceptFAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact.
Binding: Contact Relationship Type . (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingFAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ...
Binding: MediRecords Family Member Relationship Type ValueSet (extensible)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
.... name S1..1HumanNameFull name of contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... text Σ1..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... Slices for telecom S1..4ContactPointPatient contact's communication numbers/addresses. At least one contact number/address is required.
Slice: Unordered, Closed by value:system
..... telecom:contact-email S0..1ContactPointcontact's email
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codeemail
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntPreferred order of use for mode of contact. A contact must have one telecom with rank = 1.
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:contact-phone S0..3ContactPointcontact's phone number
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... value Σ0..1stringThe actual contact point details
...... use ?!