MediRecords FHIR Implementation Guide
20221128 - ci-build


Resource Profile: MediRecords Core Organisation

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-organisation-core
Version:20221128
Name:MROrganisation
Title:MediRecords Core Organisation
Status:Active as of 2023-01-25 05:48:41+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 0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... 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..1MRAusAddress, MRForeignAddressAn address in Australia for use within an Australian healthcare context
.... line 0..2stringStreet name, number, direction & P.O. Box etc.
... partOf S0..1Reference(MediRecords Core 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
... 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
.... telecom:email SC0..1ContactPointEmail
..... 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
..... 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..1MRAusAddress, MRForeignAddressAn address in Australia for use within an Australian healthcare context
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
..... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
.... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... 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Σ0..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 or suburb
Example General: Erewhon
Max Length: 60
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
Max Length: 20
.... postalCode SΣC0..1stringPostal code for area
Example General: 9132
Max Length: 10
.... country SΣ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(MediRecords Core 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 C0..*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
.... telecom:email C0..1ContactPointEmail
.... telecom:workPhone C1..1ContactPointWork Phone. The number should be of 10 digits length
... address C0..1MRAusAddress, MRForeignAddressAn address in Australia for use within an Australian healthcare context
.... isPrimary 0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
.... line Σ0..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 or suburb
Max Length: 60
.... state Σ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
Max Length: 20
.... postalCode ΣC0..1stringPostal code for area
Max Length: 10
.... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... partOf Σ0..1Reference(MediRecords Core 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 0..*AUBaseOrganisationAn organisation in an Australian healthcare context
... 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..1MRAusAddress, MRForeignAddressAn address in Australia for use within an Australian healthcare context
.... line 0..2stringStreet name, number, direction & P.O. Box etc.
... partOf S0..1Reference(MediRecords Core 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
... 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
.... telecom:email SC0..1ContactPointEmail
..... 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
..... 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..1MRAusAddress, MRForeignAddressAn address in Australia for use within an Australian healthcare context
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
..... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
.... noFixedAddress 0..1booleanNo fixed address indicator
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
.... 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Σ0..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 or suburb
Example General: Erewhon
Max Length: 60
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
Max Length: 20
.... postalCode SΣC0..1stringPostal code for area
Example General: 9132
Max Length: 10
.... country SΣ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(MediRecords Core 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 / Code
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typepreferredMRServiceProvierTypeValueSet
Organization.telecom:email.systemrequiredFixed Value: email
Organization.telecom:email.userequiredFixed Value: work
Organization.telecom:workPhone.systemrequiredFixed Value: phone
Organization.telecom:workPhone.userequiredFixed Value: work
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Organization.contact.purposeextensibleContactPurpose

Constraints

IdGradePath(s)DetailsRequirements
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-add-0errorOrganization.addressThe address shall at least have text or a line
: text.exists() or line.exists()
inv-add-1errorOrganization.addressIf 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-2errorOrganization.addressIf 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-add-3errorOrganization.address.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')
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()