MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR Organisation

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

MediRecords core Organisation profile to record a provider organisation in australian context

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.telecom is sliced based on the values of value:use, value:system

This structure is derived from AUBaseOrganisation

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Organization AUBaseOrganisation
​... meta
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
​... active S1..1booleanWhether the organization's record is still in active use
​... name S1..1stringName used for the organization
​... Slices for telecom S1..*ContactPointOrganisation's Contact Method.
Slice: Unordered, Open by value:use, value:system
​.... telecom:email S0..1ContactPointEmail
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
​..... value 1..1stringThe actual contact point details
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:workPhone S1..1ContactPointWork Phone. The number should be of 10 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value 1..1stringThe actual contact point details
Max Length: 10
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​... address S0..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
​.... line 1..2stringStreet name, number, direction & P.O. Box etc.
​... partOf S0..1Reference(MR Organisation)The organization of which this organization forms a part

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ0..*CodeableConceptKind of organization
Binding: MediRecords Service Provider Type ValueSet (preferred)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC1..*ContactPointOrganisation's Contact Method.
Slice: Unordered, Open by value:use, value:system
org-3: The telecom of an organization can never be of use 'home'
.... telecom:email SC0..1ContactPointEmail
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:workPhone SC1..1ContactPointWork Phone. The number should be of 10 digits length
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ1..2stringStreet 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
Max Length: 50
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
Max Length: 60
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
Max Length: 10
.... country SΣ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(MR Organisation)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. Organization 0..*AUBaseOrganisationAn organisation in an Australian healthcare context
​... meta Σ0..1MetaMetadata about the resource
​.... lastUpdated Σ0..1instantWhen the resource version last changed
​... identifier 0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
​... active ?!Σ1..1booleanWhether the organization's record is still in active use
​... name ΣC1..1stringName used for the organization
​... Slices for telecom C1..*ContactPointOrganisation's Contact Method.
Slice: Unordered, Open by value:use, value:system
org-3: The telecom of an organization can never be of use 'home'
​.... telecom:email C0..1ContactPointEmail
org-3: The telecom of an organization can never be of use 'home'
​.... telecom:workPhone C1..1ContactPointWork Phone. The number should be of 10 digits length
org-3: The telecom of an organization can never be of use 'home'
​... address C0..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
org-2: An address of an organization can never be of use 'home'
​.... isPrimary 0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
​.... line Σ1..2stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Max Length: 50
​.... city Σ0..1stringName of city, town etc.
Max Length: 60
​.... state Σ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
​.... postalCode Σ0..1stringPostal code for area
Max Length: 10
​.... country Σ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
​... partOf Σ0..1Reference(MR Organisation)The organization of which this organization forms a part

doco Documentation for this format

This structure is derived from AUBaseOrganisation

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.telecom is sliced based on the values of value:use, value:system

Differential View

This structure is derived from AUBaseOrganisation

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Organization AUBaseOrganisation
​... meta
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
​... active S1..1booleanWhether the organization's record is still in active use
​... name S1..1stringName used for the organization
​... Slices for telecom S1..*ContactPointOrganisation's Contact Method.
Slice: Unordered, Open by value:use, value:system
​.... telecom:email S0..1ContactPointEmail
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
​..... value 1..1stringThe actual contact point details
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:workPhone S1..1ContactPointWork Phone. The number should be of 10 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value 1..1stringThe actual contact point details
Max Length: 10
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​... address S0..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
​.... line 1..2stringStreet name, number, direction & P.O. Box etc.
​... partOf S0..1Reference(MR Organisation)The organization of which this organization forms a part

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*AUBaseOrganisationAn organisation in an Australian healthcare context
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumberIdentifies this organization across multiple systems
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ0..*CodeableConceptKind of organization
Binding: MediRecords Service Provider Type ValueSet (preferred)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC1..*ContactPointOrganisation's Contact Method.
Slice: Unordered, Open by value:use, value:system
org-3: The telecom of an organization can never be of use 'home'
.... telecom:email SC0..1ContactPointEmail
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:workPhone SC1..1ContactPointWork Phone. The number should be of 10 digits length
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ1..2stringStreet 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
Max Length: 50
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
Max Length: 60
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
Max Length: 10
.... country SΣ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(MR Organisation)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: Contact Purpose (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Organization.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.typepreferredMRServiceProvierTypeValueSet
https://fhir.medirecords.com/ValueSet/mr-service-provider-type-code
from this IG
Organization.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:workPhone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:workPhone.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.countryrequiredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Organization.contact.purposeextensibleContactPurpose
http://terminology.hl7.org.au/ValueSet/contact-purpose

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-au-postcodeerrorOrganization.addressAustralia postal code shall be 4 digits
: (country.exists() and country.matches('^AU$').not()) or postalCode.matches('^[0-9]{4}$')
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:email, Organization.telecom:workPhoneThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()