MR.R4.CORE\MR Patient

Resource Profile: MR Patient

Defining URL:

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

Version:

1.4.1

Name:

MRPatient

Title:

MR Patient

Status:

Active as of 2024-10-28 02:34:31+0000

Definition:

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

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

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

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from AUBasePatient

Summary

Mandatory: 7 elements (39 nested mandatory elements)
Must-Support: 67 elements
Fixed Value: 19 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Patient.identifier is sliced based on the value of pattern:type
The element Patient.name is sliced based on the value of value:use (Closed)
The element Patient.telecom is sliced based on the values of value:use, value:system (Closed)
The element Patient.contact.relationship is sliced based on the value of value:coding.system (Closed)
The element Patient.contact.telecom is sliced based on the value of value:system (Closed)

This structure is derived from AUBasePatient

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	PatBirthPlace	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 Binding: PatientImportance (example)
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(MR RelatedPerson)	Reference to RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson profiled by https://fhir.medirecords.com/StructureDefinition/mr-patient-relatedperson-extn
valueReference		1..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(MR Practitioner)	Use 'MRPractitioner' to represent Usual GP.
managingOrganization	S	0..1	Reference(MR Organisation)	Represents default practice id where the patient details are created
Documentation for this format

Description & Constraints

Patient

0..*

AUBasePatient

A patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date
inv-mr-pat-contact-nok-emergency-01: Can only specify one each of Emergency Contact or Next of Kin

0..1

Logical id of this artifact

Meta

Metadata about the resource

0..1

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
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, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-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-contact-nok-emergency-01	error	Patient	Can only specify one each of Emergency Contact or Next of Kin : (contact.relationship.coding.where(code = 'N' and system = 'http://terminology.hl7.org/CodeSystem/v2-0131').count() <= 1) and (contact.relationship.coding.where(code = 'C' and system = 'http://terminology.hl7.org/CodeSystem/v2-0131').count() <= 1)
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})$')
inv-pat-0	error	Patient	If present, birth time's date shall be the birth date : birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Resource Profile: MR Patient

Formal Views of Profile Content

Terminology Bindings

Constraints