Organization | Medplum

Elements

Name Required Type Description
identifier Identifier[] Identifies this organization across multiple systems
Details
Identifier for the organization that is used to identify the organization across multiple disparate systems.
active boolean Whether the organization's record is still in active use
Details
Whether the organization's record is still in active use.
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.
type CodeableConcept[] Kind of organization
Details
The kind(s) of organization that this is.
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.
name string Name used for the organization
Details
A name associated with the organization.
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.
alias string[] A list of alternate names that the organization is known as, or was known as in the past
Details
A list of alternate names that the organization is known as, or was known as in the past.
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.
telecom ContactPoint[] A contact detail for the organization
Details
A contact detail for the organization.
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.
address Address[] An address for the organization
Details
An address for the organization.
Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
partOf Reference< Organization > The organization of which this organization forms a part
Details
The organization of which this organization forms a part.
contact OrganizationContact[] Contact for the organization for a certain purpose
Details
Contact for the organization for a certain purpose.
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.
id string Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension Extension[] Additional content defined by implementations
Details
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.
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.
modifierExtension Extension[] Extensions that cannot be ignored even if unrecognized
Details
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).
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.
purpose CodeableConcept The type of contact
Details
Indicates a purpose for which the contact can be reached.
name HumanName A name associated with the contact
Details
A name associated with the contact.
telecom ContactPoint[] Contact details (telephone, email, etc.) for a contact
Details
A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
address Address Visiting or postal addresses for the contact
Details
Visiting or postal addresses for the contact.
endpoint Reference< Endpoint >[] Technical endpoints providing access to services operated for the organization
Details
Technical endpoints providing access to services operated for the organization.

Search Parameters

Name Type Description Expression
active token Is the Organization record active Organization.active
address string A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text Organization.address
address-city string A city specified in an address Organization.address.city
address-country string A country specified in an address Organization.address.country
address-postalcode string A postal code specified in an address Organization.address.postalCode
address-state string A state specified in an address Organization.address.state
address-use token A use code specified in an address Organization.address.use
endpoint reference Technical endpoints providing access to services operated for the organization Organization.endpoint
identifier token Any identifier for the organization (not the accreditation issuer's identifier) Organization.identifier
name string A portion of the organization's name or alias Organization.name
partof reference An organization of which this organization forms a part Organization.partOf
phonetic string A portion of the organization's name using some kind of phonetic matching algorithm Organization.name
type token A code for the type of organization Organization.type

Inherited Elements

Name Required Type Description
id string Logical id of this artifact
Details
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta Meta Metadata about the resource
Details
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.
implicitRules uri A set of rules under which this content was created
Details
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.
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 its narrative along with other profiles, value sets, etc.
language code Language of the resource content
Details
The base language in which the resource is written.
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).
text Narrative Text summary of the resource, for human interpretation
Details
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.
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.
contained Resource[] Contained, inline Resources
Details
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.
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.
extension Extension[] Additional content defined by implementations
Details
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.
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.
modifierExtension Extension[] Extensions that cannot be ignored
Details
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).
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.