MediRecords FHIR Implementation Guide
1.3.0 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-patient-core |
| Version: | 1.3.0 |
| Name: | MRPatient |
| Title: | MediRecords Core Patient |
| Status: | Active as of 2023-12-21 01:01:27+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
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:
This structure is derived from AUBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | C | 0..* | AUBasePatient | A 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 | S | 0..1 | instant | When the resource version last changed |
 profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
 extension:birthPlace | S | 0..1 | birthPlace | Represents 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..1 | Address | Value of extension | |
 text | S | 0..1 | string | Text representation of the address Max Length: 100 |
| extension:indigenousStatus | S | 0..1 | AustralianIndigenousStatus | Indigenous status |
| skinCode | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | Represents 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | English As Second Language Indicator Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn |
| ethnicity | S | 0..* | CodeableConcept | Ethnicity URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity |
  extension | 0..0 | |||
 valueCodeableConcept | 1..1 | CodeableConcept | Coded ethnicity Binding: MediRecords Patient Ethnicity ValueSet (required) | |
| importance | S | 0..1 | CodeableConcept | Special status given the patient URL: http://hl7.org/fhir/StructureDefinition/patient-importance |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: MediRecords Patient Importance ValueSet (required) | |
| patient-note | S | 0..1 | string | Patient demographic notes URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext |
 Slices for identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Patient'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 | S | 0..1 | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | External Patient Number (PT) |
  type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PT | |
| system | 0..1 | uri | Tenant identifier hosting the external patient number in the form 'urn:uuid:<<tenant-guid>>'. The value is ignored in write operations. | |
| value | S | 1..1 | string | External Patient Number |
 identifier:identifierIHI | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:identifierMRN | S | 0..* | AUMedicalRecordNumber | Medical Record Number (MRN) |
| identifier:identifierMCN | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
| value | C | 1..1 | string | Medicare card number inv-mr-pat-ind-mcn-value-01: Medicare Card Number must be of 11 digits |
| period | ||||
| end | C | 0..1 | dateTime | Medicare card expiry date inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierDVA | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
| identifier:identifierPCCN | S | 0..1 | AUPensionerConcessionCardNumber | Pensioner Concession Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierHCN | S | 0..1 | AUHealthCareCardNumber | Health Care Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierSHCN | S | 0..1 | AUCwlthSeniorsHealthCardNumber | Commonwealth Seniors Health Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
 identifier:identifierINS | S | 0..* | AUInsuranceMemberNumber | Insurance Member Number |
| value | 1..1 | string | Insurance member number Max Length: 15 | |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| assigner | ||||
| reference | S | 1..1 | string | Reference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API. |
| active | S | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use | |
| name:officialName | S | 1..1 | HumanName | Represents the patient official name. |
| use | S | 1..1 | code | official Fixed Value: official |
| family | S | 1..1 | string | Last Name Max Length: 40 |
| given | S | 0..2 | string | First Name and Middle Name as separate occurences Max Length: 40 |
| prefix | S | 0..1 | string | Name Title. Must match a value allowed within the MediRecords TitleID lookup list. |
| name:preferredName | S | 0..1 | HumanName | Represents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name. |
| use | 1..1 | code | usual Fixed Value: usual | |
| text | S | 0..1 | string | Preferred Name Max Length: 40 |
| name:previouslyKnownAs | S | 0..1 | HumanName | Represents the patient previously known name. Max 40 characters in length. |
| use | 1..1 | code | old Fixed Value: old | |
| text | S | 0..1 | string | Previously Known As Max Length: 40 |
| period | S | 0..1 | Period | Time period when name was/is in use |
| Slices for telecom | 1..6 | ContactPoint | Patient'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 | SC | 0..1 | ContactPoint | Email inv-mr-pat-telecom-email-value-01: Please Provide a valid email id |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| value | S | 1..1 | string | The actual contact point details Max Length: 100 |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:homePhone | SC | 0..1 | ContactPoint | Home 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:workPhone | SC | 0..1 | ContactPoint | Work 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
| telecom:mobile | SC | 0..1 | ContactPoint | Mobile. 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:sms | S | 0..1 | ContactPoint | SMS |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:letter | S | 0..1 | ContactPoint | Letter |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: other |
| value | 0..0 | |||
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | SC | 1..1 | date | Represents 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 | S | 0..1 | DateAccuracyIndicator | MediRecords 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 | S | 0..1 | dateTime | Represents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future. |
 address | SC | 0..2 | MRAusAddress, MRForeignAddress | An 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..* | Attachment | Patient's photo. Only jpg/png format is supported | |
| contact | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| related-person | S | 0..1 | Reference(MediRecords 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..1 | Reference() | Value of extension | |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| Slices for relationship | 1..* | CodeableConcept | Contact's relationship to patient Slice: Unordered, Closed by value:coding.system | |
| relationship:contact-type | S | 0..2 | CodeableConcept | Patient contact type |
| coding | 1..1 | Coding | C (Emergency Contact) | N (Next-of-kin) Binding: MediRecords Patient Contact Type ValueSet (required) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| relationship:family-relationship | S | 1..2 | CodeableConcept | FAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact. |
| coding | 1..1 | Coding | FAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ... Binding: MediRecords Family Member Relationship Type ValueSet (extensible) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| name | S | 1..1 | HumanName | Full name of contact |
| use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| text | 1..1 | string | Text representation of the full name | |
| Slices for telecom | S | 1..4 | ContactPoint | Patient contact's communication numbers/addresses. At least one contact number/address is required. Slice: Unordered, Closed by value:system |
| telecom:contact-email | S | 0..1 | ContactPoint | contact's email |
| system | 1..1 | code | email Fixed Value: email | |
| rank | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | |
| telecom:contact-phone | S | 0..3 | ContactPoint | contact's phone number |
| system | 1..1 | code | phone Fixed Value: phone | |
| use | 1..1 | code | home | work | mobile | |
| rank | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | |
 generalPractitioner | S | 0..* | Reference(MediRecords Core Practitioner) | Use 'MRPractitioner' to represent Usual GP. |
| managingOrganization | S | 0..1 | Reference(MediRecords Core Organisation) | Represents default practice id where the patient details are created |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A 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 | ||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthPlace | S | 0..1 | Address | Represents 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
| Slices for value[x] | 1..1 | Address | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueAddress | 1..1 | Address | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Max Length: 100 | ||||
| line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) | ||||
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||
| interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
| dateOfArrival | 0..1 | date | The 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | Represents 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | English As Second Language Indicator Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn | ||||
| ethnicity | S | 0..* | CodeableConcept | Ethnicity URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ethnicity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Coded ethnicity Slice: Unordered, Closed by type:$this | |||||
 value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Coded ethnicity Binding: MediRecords Patient Ethnicity ValueSet (required) | |||||
| importance | S | 0..1 | CodeableConcept | Special status given the patient URL: http://hl7.org/fhir/StructureDefinition/patient-importance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: MediRecords Patient Importance ValueSet (required) | |||||
| patient-note | S | 0..1 | string | Patient demographic notes URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Patient'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 | S | 0..1 | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | External Patient Number (PT) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PT | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | Tenant 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..1 | string | External Patient Number Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierIHI | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) | ||||
| identifier:identifierMRN | S | 0..* | AUMedicalRecordNumber | Medical Record Number (MRN) | ||||
| identifier:identifierMCN | S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | ||||
| value | ΣC | 1..1 | string | Medicare 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..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | Medicare card expiry date inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierDVA | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
| identifier:identifierPCCN | S | 0..1 | AUPensionerConcessionCardNumber | Pensioner Concession Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Pensioner Concession Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierHCN | S | 0..1 | AUHealthCareCardNumber | Health Care Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Commonwealth Seniors Health Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierSHCN | S | 0..1 | AUCwlthSeniorsHealthCardNumber | Commonwealth Seniors Health Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Commonwealth Seniors Health Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierINS | S | 0..* | AUInsuranceMemberNumber | Insurance Member Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Insurance member number Example General: 123456 Max Length: 15 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 1..1 | Reference(Organization) | Insurer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Reference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API. | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Name of insurer | ||||
| active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use | ||||
| name:officialName | SΣ | 1..1 | HumanName | Represents the patient official name. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | official Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Last Name Max Length: 40 | ||||
| given | SΣ | 0..2 | string | First 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..1 | string | Name 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..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:preferredName | SΣ | 0..1 | HumanName | Represents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual Binding: NameUse (required): The use of a human name. Fixed Value: usual | ||||
| text | SΣ | 0..1 | string | Preferred Name Max Length: 40 | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:previouslyKnownAs | SΣ | 0..1 | HumanName | Represents the patient previously known name. Max 40 characters in length. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | old Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
| text | SΣ | 0..1 | string | Previously Known As Max Length: 40 | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | SΣ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 1..6 | ContactPoint | Patient'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ΣC | 0..1 | ContactPoint | Email inv-mr-pat-telecom-email-value-01: Please Provide a valid email id | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 100 | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:homePhone | SΣC | 0..1 | ContactPoint | Home 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:workPhone | SΣC | 0..1 | ContactPoint | Work 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:mobile | SΣC | 0..1 | ContactPoint | Mobile. 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:sms | SΣ | 0..1 | ContactPoint | SMS | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:letter | SΣ | 0..1 | ContactPoint | Letter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣC | 1..1 | date | Represents 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..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | S | 0..1 | Coding | MediRecords 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: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | ||||
| birthTime | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedDateTime | ?!SΣ | 0..1 | dateTime | Represents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||
| address | SC | 0..2 | MRAusAddress, MRForeignAddress | An 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 | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
 multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Patient's photo. Only jpg/png format is supported | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| related-person | S | 0..1 | Reference(MediRecords 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |||||
| Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference | 1..1 | Reference() | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| Slices for relationship | 1..* | CodeableConcept | Contact's relationship to patient Slice: Unordered, Closed by value:coding.system Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |||||
| relationship:contact-type | S | 0..2 | CodeableConcept | Patient contact type Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | C (Emergency Contact) | N (Next-of-kin) Binding: MediRecords Patient Contact Type ValueSet (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| relationship:family-relationship | S | 1..2 | CodeableConcept | FAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact. Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | FAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ... Binding: MediRecords Family Member Relationship Type ValueSet (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | S | 1..1 | HumanName | Full name of contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 1..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | S | 1..4 | ContactPoint | Patient contact's communication numbers/addresses. At least one contact number/address is required. Slice: Unordered, Closed by value:system | ||||
| telecom:contact-email | S | 0..1 | ContactPoint | contact's email | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:contact-phone | S | 0..3 | ContactPoint | contact's phone number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | mobile Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | S | 0..* | Reference(MediRecords Core Practitioner) | Use 'MRPractitioner' to represent Usual GP. | ||||
| managingOrganization | SΣ | 0..1 | Reference(MediRecords Core Organisation) | Represents default practice id where the patient details are created | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A 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 | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| birthPlace | 0..1 | Address | Represents 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 | |
| value[x]:valueAddress | 1..1 | Address | Value of extension | |
| text | Σ | 0..1 | string | Text representation of the address Max Length: 100 |
| indigenousStatus | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) | |
| skinCode | 0..1 | CodeableConcept | Represents 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 | 0..1 | boolean | Represents 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 | 0..1 | CodeableConcept | Represents 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 | 0..1 | boolean | English As Second Language Indicator Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn | |
| ethnicity | 0..* | CodeableConcept | Ethnicity URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity | |
| importance | 0..1 | CodeableConcept | Special status given the patient URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |
| patient-note | 0..1 | string | Patient demographic notes URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext | |
| identifier:identifierPT | 0..1 | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | External Patient Number (PT) | |
| value | Σ | 1..1 | string | External Patient Number |
| identifier:identifierIHI | C | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:identifierMRN | 0..* | AUMedicalRecordNumber | Medical Record Number (MRN) | |
| identifier:identifierMCN | 0..1 | AUMedicareCardNumber | Medicare Card Number | |
| identifier:identifierDVA | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | |
| identifier:identifierPCCN | 0..1 | AUPensionerConcessionCardNumber | Pensioner Concession Card Number | |
| identifier:identifierHCN | 0..1 | AUHealthCareCardNumber | Health Care Card Number | |
| identifier:identifierSHCN | 0..1 | AUCwlthSeniorsHealthCardNumber | Commonwealth Seniors Health Card Number | |
| identifier:identifierINS | 0..* | AUInsuranceMemberNumber | Insurance Member Number | |
| assigner | Σ | 1..1 | Reference(Organization) | Insurer |
| reference | ΣC | 1..1 | string | Reference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API. |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name:officialName | Σ | 1..1 | HumanName | Represents the patient official name. |
| use | ?!Σ | 1..1 | code | official Binding: NameUse (required): The use of a human name. Fixed Value: official |
| family | Σ | 1..1 | string | Last Name Max Length: 40 |
| given | Σ | 0..2 | string | First 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 | Σ | 0..1 | string | Name 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 |
| name:preferredName | Σ | 0..1 | HumanName | Represents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name. |
| text | Σ | 0..1 | string | Preferred Name Max Length: 40 |
| name:previouslyKnownAs | Σ | 0..1 | HumanName | Represents the patient previously known name. Max 40 characters in length. |
| text | Σ | 0..1 | string | Previously Known As Max Length: 40 |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| telecom:personal-email | ΣC | 0..1 | ContactPoint | Email inv-mr-pat-telecom-email-value-01: Please Provide a valid email id |
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value | Σ | 1..1 | string | The actual contact point details Max Length: 100 |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| telecom:homePhone | ΣC | 0..1 | ContactPoint | Home 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 |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| telecom:workPhone | ΣC | 0..1 | ContactPoint | Work 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 |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| telecom:mobile | ΣC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-pat-telecom-mobile-value-01: Mobile Phone must be between 8 to 10 digits |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
| telecom:sms | Σ | 0..1 | ContactPoint | SMS |
| value | Σ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
| telecom:letter | Σ | 0..1 | ContactPoint | Letter |
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | ΣC | 1..1 | date | Represents 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 |
| accuracyIndicator | 0..1 | Coding | MediRecords 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: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Represents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future. |
| address | C | 0..2 | MRAusAddress, MRForeignAddress | An 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 |
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| related-person | 0..1 | Reference(MediRecords RelatedPerson) | Reference to RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson profiled by https://fhir.medirecords.com/StructureDefinition/mr-patient-relatedperson-extn | |
| relationship:contact-type | 0..2 | CodeableConcept | Patient contact type Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |
| relationship:family-relationship | 1..2 | CodeableConcept | FAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact. Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |
| name | 1..1 | HumanName | Full name of contact | |
| Slices for telecom | 1..4 | ContactPoint | Patient contact's communication numbers/addresses. At least one contact number/address is required. Slice: Unordered, Closed by value:system | |
| telecom:contact-email | 0..1 | ContactPoint | contact's email | |
| telecom:contact-phone | 0..3 | ContactPoint | contact's phone number | |
| generalPractitioner | 0..* | Reference(MediRecords Core Practitioner) | Use 'MRPractitioner' to represent Usual GP. | |
| managingOrganization | Σ | 0..1 | Reference(MediRecords Core Organisation) | Represents default practice id where the patient details are created |
| Documentation for this format | ||||
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:
Differential View
This structure is derived from AUBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A 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 | S | 0..1 | instant | When the resource version last changed |
| profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| extension:birthPlace | S | 0..1 | birthPlace | Represents 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..1 | Address | Value of extension | |
| text | S | 0..1 | string | Text representation of the address Max Length: 100 |
| extension:indigenousStatus | S | 0..1 | AustralianIndigenousStatus | Indigenous status |
| skinCode | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | Represents 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | English As Second Language Indicator Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn |
| ethnicity | S | 0..* | CodeableConcept | Ethnicity URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity |
| extension | 0..0 | |||
| valueCodeableConcept | 1..1 | CodeableConcept | Coded ethnicity Binding: MediRecords Patient Ethnicity ValueSet (required) | |
| importance | S | 0..1 | CodeableConcept | Special status given the patient URL: http://hl7.org/fhir/StructureDefinition/patient-importance |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: MediRecords Patient Importance ValueSet (required) | |
| patient-note | S | 0..1 | string | Patient demographic notes URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext |
| Slices for identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Patient'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 | S | 0..1 | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | External Patient Number (PT) |
| type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PT | |
| system | 0..1 | uri | Tenant identifier hosting the external patient number in the form 'urn:uuid:<<tenant-guid>>'. The value is ignored in write operations. | |
| value | S | 1..1 | string | External Patient Number |
| identifier:identifierIHI | S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| identifier:identifierMRN | S | 0..* | AUMedicalRecordNumber | Medical Record Number (MRN) |
| identifier:identifierMCN | S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
| value | C | 1..1 | string | Medicare card number inv-mr-pat-ind-mcn-value-01: Medicare Card Number must be of 11 digits |
| period | ||||
| end | C | 0..1 | dateTime | Medicare card expiry date inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierDVA | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
| identifier:identifierPCCN | S | 0..1 | AUPensionerConcessionCardNumber | Pensioner Concession Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierHCN | S | 0..1 | AUHealthCareCardNumber | Health Care Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierSHCN | S | 0..1 | AUCwlthSeniorsHealthCardNumber | Commonwealth Seniors Health Card Number |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| identifier:identifierINS | S | 0..* | AUInsuranceMemberNumber | Insurance Member Number |
| value | 1..1 | string | Insurance member number Max Length: 15 | |
| period | ||||
| end | C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported |
| assigner | ||||
| reference | S | 1..1 | string | Reference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API. |
| active | S | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use | |
| name:officialName | S | 1..1 | HumanName | Represents the patient official name. |
| use | S | 1..1 | code | official Fixed Value: official |
| family | S | 1..1 | string | Last Name Max Length: 40 |
| given | S | 0..2 | string | First Name and Middle Name as separate occurences Max Length: 40 |
| prefix | S | 0..1 | string | Name Title. Must match a value allowed within the MediRecords TitleID lookup list. |
| name:preferredName | S | 0..1 | HumanName | Represents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name. |
| use | 1..1 | code | usual Fixed Value: usual | |
| text | S | 0..1 | string | Preferred Name Max Length: 40 |
| name:previouslyKnownAs | S | 0..1 | HumanName | Represents the patient previously known name. Max 40 characters in length. |
| use | 1..1 | code | old Fixed Value: old | |
| text | S | 0..1 | string | Previously Known As Max Length: 40 |
| period | S | 0..1 | Period | Time period when name was/is in use |
| Slices for telecom | 1..6 | ContactPoint | Patient'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 | SC | 0..1 | ContactPoint | Email inv-mr-pat-telecom-email-value-01: Please Provide a valid email id |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| value | S | 1..1 | string | The actual contact point details Max Length: 100 |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:homePhone | SC | 0..1 | ContactPoint | Home 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:workPhone | SC | 0..1 | ContactPoint | Work 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
| telecom:mobile | SC | 0..1 | ContactPoint | Mobile. 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..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:sms | S | 0..1 | ContactPoint | SMS |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:letter | S | 0..1 | ContactPoint | Letter |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: other |
| value | 0..0 | |||
| use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | SC | 1..1 | date | Represents 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 | S | 0..1 | DateAccuracyIndicator | MediRecords 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 | S | 0..1 | dateTime | Represents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future. |
| address | SC | 0..2 | MRAusAddress, MRForeignAddress | An 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..* | Attachment | Patient's photo. Only jpg/png format is supported | |
| contact | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| related-person | S | 0..1 | Reference(MediRecords 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..1 | Reference() | Value of extension | |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| Slices for relationship | 1..* | CodeableConcept | Contact's relationship to patient Slice: Unordered, Closed by value:coding.system | |
| relationship:contact-type | S | 0..2 | CodeableConcept | Patient contact type |
| coding | 1..1 | Coding | C (Emergency Contact) | N (Next-of-kin) Binding: MediRecords Patient Contact Type ValueSet (required) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| relationship:family-relationship | S | 1..2 | CodeableConcept | FAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact. |
| coding | 1..1 | Coding | FAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ... Binding: MediRecords Family Member Relationship Type ValueSet (extensible) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| name | S | 1..1 | HumanName | Full name of contact |
| use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| text | 1..1 | string | Text representation of the full name | |
| Slices for telecom | S | 1..4 | ContactPoint | Patient contact's communication numbers/addresses. At least one contact number/address is required. Slice: Unordered, Closed by value:system |
| telecom:contact-email | S | 0..1 | ContactPoint | contact's email |
| system | 1..1 | code | email Fixed Value: email | |
| rank | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | |
| telecom:contact-phone | S | 0..3 | ContactPoint | contact's phone number |
| system | 1..1 | code | phone Fixed Value: phone | |
| use | 1..1 | code | home | work | mobile | |
| rank | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | |
| generalPractitioner | S | 0..* | Reference(MediRecords Core Practitioner) | Use 'MRPractitioner' to represent Usual GP. |
| managingOrganization | S | 0..1 | Reference(MediRecords Core Organisation) | Represents default practice id where the patient details are created |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | AUBasePatient | A 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 | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthPlace | S | 0..1 | Address | Represents 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
| Slices for value[x] | 1..1 | Address | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueAddress | 1..1 | Address | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Max Length: 100 | ||||
| line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| indigenousStatus | S | 0..1 | Coding | Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required) | ||||
| closingTheGapRegistration | 0..1 | boolean | Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration | |||||
| mothersMaidenName | 0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||
| interpreterRequired | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
| dateOfArrival | 0..1 | date | The 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | Represents 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 | S | 0..1 | CodeableConcept | Represents 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 | S | 0..1 | boolean | English As Second Language Indicator Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-eng-secondlang-ind-extn | ||||
| ethnicity | S | 0..* | CodeableConcept | Ethnicity URL: http://hl7.org.au/fhir/StructureDefinition/ethnicity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/ethnicity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Coded ethnicity Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Coded ethnicity Binding: MediRecords Patient Ethnicity ValueSet (required) | |||||
| importance | S | 0..1 | CodeableConcept | Special status given the patient URL: http://hl7.org/fhir/StructureDefinition/patient-importance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: MediRecords Patient Importance ValueSet (required) | |||||
| patient-note | S | 0..1 | string | Patient demographic notes URL: https://fhir.medirecords.com/StructureDefinition/mr-patient-note-ext | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | Patient'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 | S | 0..1 | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | External Patient Number (PT) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PT | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | Tenant 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..1 | string | External Patient Number Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierIHI | SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) | ||||
| identifier:identifierMRN | S | 0..* | AUMedicalRecordNumber | Medical Record Number (MRN) | ||||
| identifier:identifierMCN | S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MC | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/medicare-number | ||||
| value | ΣC | 1..1 | string | Medicare 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..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | Medicare card expiry date inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierDVA | S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
| identifier:identifierPCCN | S | 0..1 | AUPensionerConcessionCardNumber | Pensioner Concession Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PEN | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Pensioner Concession Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierHCN | S | 0..1 | AUHealthCareCardNumber | Health Care Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Commonwealth Seniors Health Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierSHCN | S | 0..1 | AUCwlthSeniorsHealthCardNumber | Commonwealth Seniors Health Card Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SEN | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number | ||||
| value | Σ | 1..1 | string | Centrelink CRN as displayed on the Commonwealth Seniors Health Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length: 10 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:identifierINS | S | 0..* | AUInsuranceMemberNumber | Insurance Member Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MB | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 1..1 | uri | System identifier namespace for the insurer that assigned the insurance member number Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Insurance member number Example General: 123456 Max Length: 15 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing inv-mr-pat-exp-date-format-01: Only YYYY-MM format is supported | ||||
| assigner | Σ | 1..1 | Reference(Organization) | Insurer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Reference to MediRecords Health Fund Organization, required to store Member Number. Note, referenced organization can not currently be retreived using API. | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Name of insurer | ||||
| active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Closed by value:use | ||||
| name:officialName | SΣ | 1..1 | HumanName | Represents the patient official name. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | official Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Last Name Max Length: 40 | ||||
| given | SΣ | 0..2 | string | First 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..1 | string | Name 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..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:preferredName | SΣ | 0..1 | HumanName | Represents the patient preferred name. If no preferred name is entered, the first name is stored as the preferred name. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual Binding: NameUse (required): The use of a human name. Fixed Value: usual | ||||
| text | SΣ | 0..1 | string | Preferred Name Max Length: 40 | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:previouslyKnownAs | SΣ | 0..1 | HumanName | Represents the patient previously known name. Max 40 characters in length. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | old Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
| text | SΣ | 0..1 | string | Previously Known As Max Length: 40 | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | SΣ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 1..6 | ContactPoint | Patient'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ΣC | 0..1 | ContactPoint | Email inv-mr-pat-telecom-email-value-01: Please Provide a valid email id | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 100 | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:homePhone | SΣC | 0..1 | ContactPoint | Home 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:workPhone | SΣC | 0..1 | ContactPoint | Work 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:mobile | SΣC | 0..1 | ContactPoint | Mobile. 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:sms | SΣ | 0..1 | ContactPoint | SMS | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:letter | SΣ | 0..1 | ContactPoint | Letter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other | ||||
| use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣC | 1..1 | date | Represents 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..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | S | 0..1 | Coding | MediRecords 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: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | ||||
| birthTime | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedDateTime | ?!SΣ | 0..1 | dateTime | Represents the patient date of death in the format YYYY-MM-DD. Date of death should not be in the future. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| accuracyIndicator | 0..1 | Coding | Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Deceased indicator | ||||
| address | SC | 0..2 | MRAusAddress, MRForeignAddress | An 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 | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Patient's photo. Only jpg/png format is supported | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| related-person | S | 0..1 | Reference(MediRecords 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |||||
| Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference | 1..1 | Reference() | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| Slices for relationship | 1..* | CodeableConcept | Contact's relationship to patient Slice: Unordered, Closed by value:coding.system Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | |||||
| relationship:contact-type | S | 0..2 | CodeableConcept | Patient contact type Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | C (Emergency Contact) | N (Next-of-kin) Binding: MediRecords Patient Contact Type ValueSet (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| relationship:family-relationship | S | 1..2 | CodeableConcept | FAMMEMB indicates family relationship contact. Specific 'familial' relationship is required for each contact. Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | FAMMEMB (family member) | BRO (brother) | SIS (sister) | FTH (father) | MTH (mother) | ... Binding: MediRecords Family Member Relationship Type ValueSet (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | S | 1..1 | HumanName | Full name of contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 1..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | S | 1..4 | ContactPoint | Patient contact's communication numbers/addresses. At least one contact number/address is required. Slice: Unordered, Closed by value:system | ||||
| telecom:contact-email | S | 0..1 | ContactPoint | contact's email | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:contact-phone | S | 0..3 | ContactPoint | contact's phone number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | mobile Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Preferred order of use for mode of contact. A contact must have one telecom with rank = 1. | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | 0..1 | Address, AustralianAddress | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | S | 0..* | Reference(MediRecords Core Practitioner) | Use 'MRPractitioner' to represent Usual GP. | ||||
| managingOrganization | SΣ | 0..1 | Reference(MediRecords Core Organisation) | Represents default practice id where the patient details are created | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | ||||
| Patient.meta.security | extensible | All Security Labels | ||||
| Patient.meta.tag | example | CommonTags | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:birthPlace.value[x]:valueAddress.use | required | AddressUse | ||||
| Patient.extension:birthPlace.value[x]:valueAddress.type | required | AddressType | ||||
| Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | MRPatientEthnicityValueSet (a valid code from MediRecords Patient Ethnicity CodeSystem) | ||||
| Patient.extension:importance.value[x]:valueCodeableConcept | required | MRPatientImportanceValueSet (a valid code from MediRecords Patient Importance CodeSystem) | ||||
| Patient.identifier:identifierPT.use | required | IdentifierUse | ||||
| Patient.identifier:identifierPT.type | extensible | Pattern: PT | ||||
| Patient.identifier:identifierMCN.use | required | IdentifierUse | ||||
| Patient.identifier:identifierMCN.type | extensible | Pattern: MC | ||||
| Patient.identifier:identifierPCCN.use | required | IdentifierUse | ||||
| Patient.identifier:identifierPCCN.type | extensible | Pattern: PEN | ||||
| Patient.identifier:identifierHCN.use | required | IdentifierUse | ||||
| Patient.identifier:identifierHCN.type | extensible | Pattern: HC | ||||
| Patient.identifier:identifierSHCN.use | required | IdentifierUse | ||||
| Patient.identifier:identifierSHCN.type | extensible | Pattern: SEN | ||||
| Patient.identifier:identifierINS.use | required | IdentifierUse | ||||
| Patient.identifier:identifierINS.type | extensible | Pattern: MB | ||||
| Patient.identifier:identifierINS.assigner.type | extensible | ResourceType | ||||
| Patient.name:officialName.use | required | Fixed Value: official | ||||
| Patient.name:preferredName.use | required | Fixed Value: usual | ||||
| Patient.name:previouslyKnownAs.use | required | Fixed Value: old | ||||
| Patient.telecom:personal-email.system | required | Fixed Value: email | ||||
| Patient.telecom:personal-email.use | required | Fixed Value: home | ||||
| Patient.telecom:homePhone.system | required | Fixed Value: phone | ||||
| Patient.telecom:homePhone.use | required | Fixed Value: home | ||||
| Patient.telecom:workPhone.system | required | Fixed Value: phone | ||||
| Patient.telecom:workPhone.use | required | Fixed Value: work | ||||
| Patient.telecom:mobile.system | required | Fixed Value: phone | ||||
| Patient.telecom:mobile.use | required | Fixed Value: mobile | ||||
| Patient.telecom:sms.system | required | Fixed Value: sms | ||||
| Patient.telecom:sms.use | required | Fixed Value: mobile | ||||
| Patient.telecom:letter.system | required | Fixed Value: other | ||||
| Patient.telecom:letter.use | required | Fixed Value: home | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.extension:related-person.value[x]:valueReference.type | extensible | ResourceType | ||||
| Patient.contact.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
| Patient.contact.relationship:contact-type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
| Patient.contact.relationship:contact-type.coding | required | MRPatientContactType | ||||
| Patient.contact.relationship:family-relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 | ||||
| Patient.contact.relationship:family-relationship.coding | extensible | MRFamilyMemberRelationshipTypeValueSet | ||||
| Patient.contact.name.use | required | Pattern: official | ||||
| Patient.contact.telecom:contact-email.system | required | Fixed Value: email | ||||
| Patient.contact.telecom:contact-email.use | required | ContactPointUse | ||||
| Patient.contact.telecom:contact-phone.system | required | Fixed Value: phone | ||||
| Patient.contact.telecom:contact-phone.use | required | ContactPointUse | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| inv-add-0 | error | Patient.address | The address shall at least have text or a line : text.exists() or line.exists() | |
| inv-add-1 | error | Patient.address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
| inv-add-2 | error | Patient.address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
| inv-ihi-value-0 | error | Patient.identifier:identifierIHI | IHI shall be an exactly 16 digit number : value.matches('^([0-9]{16})$') | |
| inv-ihi-value-1 | error | Patient.identifier:identifierIHI | IHI prefix is 800360 : value.startsWith('800360') | |
| inv-ihi-value-2 | error | Patient.identifier:identifierIHI | IHI shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) | |
| inv-mr-address-elements-required | error | Patient.address | For an Address: line, city, state, postalCode and country are all mandatory : $this.exists() implies (line.exists() and city.exists() and state.exists() and postalCode.exists() and country.exists()) | |
| inv-mr-pat-dob-value-01 | error | Patient.birthDate | Date Of Birth must be in YYYY-MM-DD format : ($this as date).toString().matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$') | |
| inv-mr-pat-exp-date-format-01 | error | Patient.identifier:identifierMCN.period.end, Patient.identifier:identifierPCCN.period.end, Patient.identifier:identifierHCN.period.end, Patient.identifier:identifierSHCN.period.end, Patient.identifier:identifierINS.period.end | Only YYYY-MM format is supported : ($this as dateTime).toString().matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])$') | |
| inv-mr-pat-ind-mcn-value-01 | error | Patient.identifier:identifierMCN.value | Medicare Card Number must be of 11 digits : value.matches('^([0-9]{11})$') | |
| inv-mr-pat-telecom-email-value-01 | error | Patient.telecom:personal-email | Please Provide a valid email id : value.matches('^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$') | |
| inv-mr-pat-telecom-home-value-01 | error | Patient.telecom:homePhone | Home Phone must be between 8 to 10 digits : value.matches('^([0-9]{8,10})$') | |
| inv-mr-pat-telecom-mobile-value-01 | error | Patient.telecom:mobile | Mobile Phone must be between 8 to 10 digits : value.matches('^([0-9]{8,10})$') | |
| inv-mr-pat-telecom-work-value-01 | error | Patient.telecom:workPhone | Work Phone must be between 8 to 10 digits : value.matches('^([0-9]{8,10})$') |