Aged Care Clinical Note
0.1.0-preview - Preview
Aged Care Clinical Note - Local Development build (v0.1.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Page standards status: Draft | Maturity Level: 0 |
Definitions for the au-aged-care-clin-note-organization resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Organization | ||||||||||
| Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. | |||||||||
| Short | Australian Aged Care Clinical Note OrganizationA grouping of people or organizations with a common purpose | |||||||||
| Control | 0..* | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ( (identifier.count() + name.count()) > 0)org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0) | |||||||||
| 2. Organization.implicitRules | ||||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||
| Short | A set of rules under which this content was created | |||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||
| Control | 0..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 4. Organization.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| Short | Extensions that cannot be ignored | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||
| Summary | false | |||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||
| 6. Organization.identifier | ||||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systemsIdentifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 10..* This element is affected by the following invariants: org-1, au-core-org-01 | |||||||||
| Type | Identifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Must Support Types | No must-support rules about the choice of types/profiles | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O ( type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')))OrgIdentifierLength: Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. ( value.length() >= 1 and value.length() <= 20) | |||||||||
| Slicing | This element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 8. Organization.identifier:hpio | ||||||||||
| Slice Name | hpio | |||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systemsIdentifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1* This element is affected by the following invariants: org-1 | |||||||||
| Type | Identifier(AU HPI-O) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 10. Organization.identifier:abn | ||||||||||
| Slice Name | abn | |||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systemsIdentifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..* This element is affected by the following invariants: org-1 | |||||||||
| Type | Identifier(AU Australian Business Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 12. Organization.active | ||||||||||
| Definition | Whether the organization's record is still in active use. | |||||||||
| Short | Whether the organization's record is still in active use | |||||||||
| Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. | |||||||||
| Control | 0..1 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. | |||||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 14. Organization.type | ||||||||||
| Definition | The kind(s) of organization that this is. | |||||||||
| Short | Kind of organization | |||||||||
| Comments | When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. | |||||||||
| Control | 0..* | |||||||||
| Binding | The codes SHOULD be taken from For example codes, see Healthcare Organisation Role Type  http://hl7.org/fhir/ValueSet/organization-type|4.0.1(preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 16. Organization.name | ||||||||||
| Definition | A name associated with the organization. | |||||||||
| Short | Name used for the organization | |||||||||
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. | |||||||||
| Control | 10..1 This element is affected by the following invariants: org-1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Need to use the name as the label of the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 18. Organization.telecom | ||||||||||
| Definition | A contact detail for the organization. | |||||||||
| Short | A contact detail for the organization | |||||||||
| Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. | |||||||||
| Control | 0..* This element is affected by the following invariants: org-3 | |||||||||
| Type | ContactPoint | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | false | |||||||||
| Requirements | Human contact for the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty())org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty()) | |||||||||
| 20. Organization.address | ||||||||||
| Definition | An address for the organization. | |||||||||
| Short | An address for the organization | |||||||||
| Comments | The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. | |||||||||
| Control | 0..* This element is affected by the following invariants: org-2 | |||||||||
| Type | Address(Australian Address) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | false | |||||||||
| Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-2: An address of an organization can never be of use 'home' ( where(use = 'home').empty())org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty()) | |||||||||
| 22. Organization.address.extension:identifier | ||||||||||
| Slice Name | identifier | |||||||||
| Definition | A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address. | |||||||||
| Short | Identifier for the address | |||||||||
| Control | 0..* | |||||||||
| Type | Extension(Address Identifier) (Extension Type: Identifier(Identifier)) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||
| 24. Organization.address.extension:identifier.url | ||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||||||||
| Short | identifies the meaning of the extension | |||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||||||||
| Control | 1..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| Fixed Value | http://hl7.org.au/fhir/StructureDefinition/address-identifier | |||||||||
| 26. Organization.address.extension:identifier.value[x] | ||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||||||||
| Short | Address identifierValue of extension | |||||||||
| Control | 10..1 | |||||||||
| Type | Identifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | |||||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 28. Organization.address.extension:noFixedAddress | ||||||||||
| Slice Name | noFixedAddress | |||||||||
| Definition | No fixed address indicator. | |||||||||
| Short | No fixed address indicator | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-1, inv-add-2 | |||||||||
| Type | Extension(No Fixed Address) (Extension Type: boolean) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||
| 30. Organization.address.use | ||||||||||
| Definition | The purpose of this address. | |||||||||
| Short | home | work | temp | old | billing - purpose of this address | |||||||||
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. | |||||||||
| Type | code | |||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | |||||||||
| Example | General: home | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 32. Organization.address.text | ||||||||||
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | |||||||||
| Short | Text representation of the address | |||||||||
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-0, inv-add-2 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | A renderable, unencoded form. | |||||||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 34. Organization.address.city | ||||||||||
| Definition | The name of the city, town, suburb, village or other community or delivery center. | |||||||||
| Short | Name of city, town or suburbName of city, town etc. | |||||||||
| Control | 10..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Alternate Names | Municpality | |||||||||
| Example | General: Erewhon | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 36. Organization.address.country | ||||||||||
| Definition | Fixed value if present otherwise assumed to be Australia in this context. Country - a nation as commonly understood or generally accepted. | |||||||||
| Short | Australia as a 2 digit ISO 3166 codeCountry (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Fixed Value | AU | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Organization | |
| Short | Australian Aged Care Clinical Note Organization |
| 2. Organization.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Invariants | OrgIdentifierLength: Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. (value.length() >= 1 and value.length() <= 20) |
| 4. Organization.address | |
| Type | Address(Australian Address) |
| 6. Organization.address.city | |
| Control | 1..? |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Organization | ||||||||||
| Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. | |||||||||
| Short | Australian Aged Care Clinical Note Organization | |||||||||
| Control | 0..* | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ( (identifier.count() + name.count()) > 0) | |||||||||
| 2. Organization.id | ||||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||
| Short | Logical id of this artifact | |||||||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||
| Control | 0..1 | |||||||||
| Type | id | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| 4. Organization.meta | ||||||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||||||||
| Short | Metadata about the resource | |||||||||
| Control | 0..1 | |||||||||
| Type | Meta | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 6. Organization.implicitRules | ||||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||
| Short | A set of rules under which this content was created | |||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||
| Control | 0..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 8. Organization.language | ||||||||||
| Definition | The base language in which the resource is written. | |||||||||
| Short | Language of the resource content | |||||||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 10. Organization.text | ||||||||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||||||||
| Short | Text summary of the resource, for human interpretation | |||||||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||||||||
| Control | 0..1 | |||||||||
| Type | Narrative | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | narrative, html, xhtml, display | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 12. Organization.contained | ||||||||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||||||||
| Short | Contained, inline Resources | |||||||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||||||||
| Control | 0..* | |||||||||
| Type | Resource | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | inline resources, anonymous resources, contained resources | |||||||||
| 14. Organization.extension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
| Short | Additional content defined by implementations | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 16. Organization.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| Short | Extensions that cannot be ignored | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||
| Summary | false | |||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 18. Organization.identifier | ||||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 1..* This element is affected by the following invariants: org-1, au-core-org-01 | |||||||||
| Type | Identifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Must Support Types | No must-support rules about the choice of types/profiles | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O ( type.coding.where(code='NOI').exists() implies ((system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0')))OrgIdentifierLength: Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters. ( value.length() >= 1 and value.length() <= 20) | |||||||||
| Slicing | This element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 20. Organization.identifier:hpio | ||||||||||
| Slice Name | hpio | |||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1 This element is affected by the following invariants: org-1 | |||||||||
| Type | Identifier(AU HPI-O) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 22. Organization.identifier:abn | ||||||||||
| Slice Name | abn | |||||||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |||||||||
| Short | Identifies this organization across multiple systems | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..* This element is affected by the following invariants: org-1 | |||||||||
| Type | Identifier(AU Australian Business Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 24. Organization.active | ||||||||||
| Definition | Whether the organization's record is still in active use. | |||||||||
| Short | Whether the organization's record is still in active use | |||||||||
| Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. | |||||||||
| Control | 0..1 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. | |||||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 26. Organization.type | ||||||||||
| Definition | The kind(s) of organization that this is. | |||||||||
| Short | Kind of organization | |||||||||
| Comments | When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used. | |||||||||
| Control | 0..* | |||||||||
| Binding | The codes SHOULD be taken from Healthcare Organisation Role Type (preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 28. Organization.name | ||||||||||
| Definition | A name associated with the organization. | |||||||||
| Short | Name used for the organization | |||||||||
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. | |||||||||
| Control | 1..1 This element is affected by the following invariants: org-1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Requirements | Need to use the name as the label of the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 30. Organization.alias | ||||||||||
| Definition | A list of alternate names that the organization is known as, or was known as in the past. | |||||||||
| Short | A list of alternate names that the organization is known as, or was known as in the past | |||||||||
| Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. | |||||||||
| Control | 0..* | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 32. Organization.telecom | ||||||||||
| Definition | A contact detail for the organization. | |||||||||
| Short | A contact detail for the organization | |||||||||
| Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. | |||||||||
| Control | 0..* This element is affected by the following invariants: org-3 | |||||||||
| Type | ContactPoint | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | false | |||||||||
| Requirements | Human contact for the organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty()) | |||||||||
| 34. Organization.address | ||||||||||
| Definition | An address for the organization. | |||||||||
| Short | An address for the organization | |||||||||
| Comments | The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | |||||||||
| Control | 0..* This element is affected by the following invariants: org-2 | |||||||||
| Type | Address(Australian Address) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | false | |||||||||
| Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))org-2: An address of an organization can never be of use 'home' ( where(use = 'home').empty()) | |||||||||
| 36. Organization.address.id | ||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
| Short | Unique id for inter-element referencing | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 38. Organization.address.extension | ||||||||||
| Definition | An Extension | |||||||||
| Short | Extension | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 40. Organization.address.extension:identifier | ||||||||||
| Slice Name | identifier | |||||||||
| Definition | A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address. | |||||||||
| Short | Identifier for the address | |||||||||
| Control | 0..* | |||||||||
| Type | Extension(Address Identifier) (Extension Type: Identifier(Identifier)) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 42. Organization.address.extension:identifier.id | ||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
| Short | Unique id for inter-element referencing | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 44. Organization.address.extension:identifier.extension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
| Short | Additional content defined by implementations | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on Organization.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 46. Organization.address.extension:identifier.url | ||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||||||||
| Short | identifies the meaning of the extension | |||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||||||||
| Control | 1..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| Fixed Value | http://hl7.org.au/fhir/StructureDefinition/address-identifier | |||||||||
| 48. Organization.address.extension:identifier.value[x] | ||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||||||||
| Short | Address identifier | |||||||||
| Control | 1..1 | |||||||||
| Type | Identifier(Identifier, AU Delivery Point Identifier, AU G-NAF Identifier) | |||||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 50. Organization.address.extension:noFixedAddress | ||||||||||
| Slice Name | noFixedAddress | |||||||||
| Definition | No fixed address indicator. | |||||||||
| Short | No fixed address indicator | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-1, inv-add-2 | |||||||||
| Type | Extension(No Fixed Address) (Extension Type: boolean) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 52. Organization.address.use | ||||||||||
| Definition | The purpose of this address. | |||||||||
| Short | home | work | temp | old | billing - purpose of this address | |||||||||
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. | |||||||||
| Type | code | |||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | |||||||||
| Example | General: home | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 54. Organization.address.type | ||||||||||
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | |||||||||
| Short | postal | physical | both | |||||||||
| Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-1 | |||||||||
| Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)The type of an address (physical / postal). | |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Example | General: both | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 56. Organization.address.text | ||||||||||
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | |||||||||
| Short | Text representation of the address | |||||||||
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-0, inv-add-2 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | A renderable, unencoded form. | |||||||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 58. Organization.address.line | ||||||||||
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | |||||||||
| Short | Street name, number, direction & P.O. Box etc. | |||||||||
| Control | 0..* This element is affected by the following invariants: inv-add-0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Example | General: 137 Nowhere Street | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 60. Organization.address.city | ||||||||||
| Definition | The name of the city, town, suburb, village or other community or delivery center. | |||||||||
| Short | Name of city, town or suburb | |||||||||
| Control | 1..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Alternate Names | Municpality | |||||||||
| Example | General: Erewhon | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 62. Organization.address.district | ||||||||||
| Definition | The name of the administrative area (county). | |||||||||
| Short | District name (aka county) | |||||||||
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Alternate Names | County | |||||||||
| Example | General: Madison | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 64. Organization.address.state | ||||||||||
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | |||||||||
| Short | Australian state or territory | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHALL be taken from Australian States and Territories (required to https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2) | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Alternate Names | Province, Territory | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 66. Organization.address.postalCode | ||||||||||
| Definition | A postal code designating a region defined by the postal service. | |||||||||
| Short | Postal code for area | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-add-3 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Alternate Names | Zip | |||||||||
| Example | General: 9132 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))inv-add-3: Postal code shall be 4 digits ( matches('^[0-9]{4}$')) | |||||||||
| 68. Organization.address.country | ||||||||||
| Definition | Fixed value if present otherwise assumed to be Australia in this context. | |||||||||
| Short | Australia as a 2 digit ISO 3166 code | |||||||||
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Fixed Value | AU | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 70. Organization.address.period | ||||||||||
| Definition | Time period when address was/is in use. | |||||||||
| Short | Time period when address was/is in use | |||||||||
| Control | 0..1 | |||||||||
| Type | Period | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Requirements | Allows addresses to be placed in historical context. | |||||||||
| Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" } | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 72. Organization.partOf | ||||||||||
| Definition | The organization of which this organization forms a part. | |||||||||
| Short | The organization of which this organization forms a part | |||||||||
| Control | 0..1 | |||||||||
| Type | Reference(Organization) | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Requirements | Need to be able to track the hierarchy of organizations within an organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 74. Organization.contact | ||||||||||
| Definition | Contact for the organization for a certain purpose. | |||||||||
| Short | Contact for the organization for a certain purpose | |||||||||
| Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. | |||||||||
| Control | 0..* | |||||||||
| Type | BackboneElement | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Need to keep track of assigned contact points within bigger organization. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 76. Organization.contact.id | ||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||
| Short | Unique id for inter-element referencing | |||||||||
| Control | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 78. Organization.contact.extension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
| Short | Additional content defined by implementations | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 80. Organization.contact.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||
| Summary | true | |||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 82. Organization.contact.purpose | ||||||||||
| Definition | Indicates a purpose for which the contact can be reached. | |||||||||
| Short | The type of contact | |||||||||
| Control | 0..1 | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Contact Purpose (extensible to http://terminology.hl7.org.au/ValueSet/contact-purpose) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Need to distinguish between multiple contact persons. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 84. Organization.contact.name | ||||||||||
| Definition | A name associated with the contact. | |||||||||
| Short | A name associated with the contact | |||||||||
| Control | 0..1 | |||||||||
| Type | HumanName | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Need to be able to track the person by name. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 86. Organization.contact.telecom | ||||||||||
| Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | |||||||||
| Short | Contact details (telephone, email, etc.) for a contact | |||||||||
| Control | 0..* | |||||||||
| Type | ContactPoint | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 88. Organization.contact.address | ||||||||||
| Definition | Visiting or postal addresses for the contact. | |||||||||
| Short | Visiting or postal addresses for the contact | |||||||||
| Control | 0..1 | |||||||||
| Type | Address | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 90. Organization.endpoint | ||||||||||
| Definition | Technical endpoints providing access to services operated for the organization. | |||||||||
| Short | Technical endpoints providing access to services operated for the organization | |||||||||
| Control | 0..* | |||||||||
| Type | Reference(Endpoint) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
IG © 2025+ Australian Digital Health Agency. Package au.digitalhealth.r4.agedcareclinicalnote#0.1.0-preview based on FHIR 4.0.1. Generated 2025-12-05
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
