Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-organisation-core |
Version: | 1.3.0 |
Name: | MROrganisation |
Title: | MediRecords Core Organisation |
Status: | Active as of 2023-12-21 01:01:27+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
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:
This structure is derived from AUBaseOrganisation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context | |
meta | ||||
lastUpdated | S | 0..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 0..* | CodeableConcept | Kind of organization Binding: MediRecords Service Provider Type ValueSet (preferred) |
name | S | 1..1 | string | Name used for the organization |
Slices for telecom | S | 1..* | ContactPoint | Organisation's Contact Method. Slice: Unordered, Open by value:use, value:system |
telecom:email | S | 0..1 | ContactPoint | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | The actual contact point details | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
telecom:workPhone | S | 1..1 | ContactPoint | Work Phone. The number should be of 10 digits length |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | The actual contact point details Max Length: 10 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
address | S | 0..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
line | 1..2 | string | Street name, number, direction & P.O. Box etc. | |
partOf | S | 0..1 | Reference(MediRecords Core Organisation) | The organization of which this organization forms a part |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context | ||||
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 | Σ | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
type | SΣ | 0..* | CodeableConcept | Kind of organization Binding: MediRecords Service Provider Type ValueSet (preferred) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
Slices for telecom | SC | 1..* | ContactPoint | Organisation's Contact Method. Slice: Unordered, Open by value:use, value:system | ||||
telecom:email | SC | 0..1 | ContactPoint | 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 | 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 | ||||
use | ?!Σ | 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:workPhone | SC | 1..1 | ContactPoint | Work Phone. The number should be of 10 digits 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 | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | The actual contact point details Max Length: 10 | ||||
use | ?!Σ | 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 | ||||
address | SC | 0..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | ||||
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 | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 1..2 | 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 Max Length: 50 | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Max Length: 60 | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Max Length: 10 | ||||
country | SΣ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | SΣ | 0..1 | Reference(MediRecords Core Organisation) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
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 | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context |
meta | Σ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
identifier | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems | |
active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: MediRecords Service Provider Type ValueSet (preferred) |
name | ΣC | 1..1 | string | Name used for the organization |
Slices for telecom | C | 1..* | ContactPoint | Organisation's Contact Method. Slice: Unordered, Open by value:use, value:system |
telecom:email | C | 0..1 | ContactPoint | Email |
telecom:workPhone | C | 1..1 | ContactPoint | Work Phone. The number should be of 10 digits length |
address | C | 0..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
isPrimary | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | |
line | Σ | 1..2 | string | Street 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..1 | string | Name of city, town etc. Max Length: 60 |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 |
postalCode | Σ | 0..1 | string | Postal code for area Max Length: 10 |
country | Σ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) |
partOf | Σ | 0..1 | Reference(MediRecords Core Organisation) | The organization of which this organization forms a part |
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:
Differential View
This structure is derived from AUBaseOrganisation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context | |
meta | ||||
lastUpdated | S | 0..1 | instant | When the resource version last changed |
profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 0..* | CodeableConcept | Kind of organization Binding: MediRecords Service Provider Type ValueSet (preferred) |
name | S | 1..1 | string | Name used for the organization |
Slices for telecom | S | 1..* | ContactPoint | Organisation's Contact Method. Slice: Unordered, Open by value:use, value:system |
telecom:email | S | 0..1 | ContactPoint | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | The actual contact point details | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
telecom:workPhone | S | 1..1 | ContactPoint | Work Phone. The number should be of 10 digits length |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | The actual contact point details Max Length: 10 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
address | S | 0..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
line | 1..2 | string | Street name, number, direction & P.O. Box etc. | |
partOf | S | 0..1 | Reference(MediRecords Core Organisation) | The organization of which this organization forms a part |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | AUBaseOrganisation | An organisation in an Australian healthcare context | ||||
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 | Σ | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier, AUHPIO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber | Identifies this organization across multiple systems | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
type | SΣ | 0..* | CodeableConcept | Kind of organization Binding: MediRecords Service Provider Type ValueSet (preferred) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
Slices for telecom | SC | 1..* | ContactPoint | Organisation's Contact Method. Slice: Unordered, Open by value:use, value:system | ||||
telecom:email | SC | 0..1 | ContactPoint | 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 | 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 | ||||
use | ?!Σ | 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:workPhone | SC | 1..1 | ContactPoint | Work Phone. The number should be of 10 digits 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 | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | The actual contact point details Max Length: 10 | ||||
use | ?!Σ | 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 | ||||
address | SC | 0..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | ||||
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 | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 1..2 | 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 Max Length: 50 | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Max Length: 60 | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Max Length: 10 | ||||
country | SΣ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | SΣ | 0..1 | Reference(MediRecords Core Organisation) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
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 | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: Contact Purpose (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | CommonTags | ||||
Organization.language | preferred | CommonLanguages
| ||||
Organization.type | preferred | MRServiceProvierTypeValueSet | ||||
Organization.telecom:email.system | required | Fixed Value: email | ||||
Organization.telecom:email.use | required | Fixed Value: work | ||||
Organization.telecom:workPhone.system | required | Fixed Value: phone | ||||
Organization.telecom:workPhone.use | required | Fixed Value: work | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.address.country | required | Iso3166-1-2 | ||||
Organization.contact.purpose | extensible | ContactPurpose |
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-au-postcode | error | Organization.address | Australia postal code shall be 4 digits : (country.exists() and country.matches('^AU$').not()) or postalCode.matches('^[0-9]{4}$') | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:email, Organization.telecom:workPhone | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |