This resource defines a group of individuals or clinicians that form an organization of some kind. An organization record may consist of multiple organizations, like an umbrella healthcare organization with multiple physical locations.
You can review, retrieve, create, or update organization records.
update
Update the details of an organization record in your connection's system.
cURL request example
Request Parameters
- idrequired, string
Organization identifier
- resourceTyperequired, string
Identifies the type of the resource
Value:Organization - activerequired, boolean
Whether the organization's record is still in active use.
- namerequired, string
A name associated with the organization.
- containedArray of object
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.
- resourceTyperequired, string
Identifies the type of the resource
Value:Endpoint - statusrequired, string
active | suspended | error | off | test.
Possible Values:active,suspended,error,off,entered-in-error,test - connectionTyperequired, object
A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
- systemstring
The identification of the code system that defines the meaning of the symbol in the code.
Value:https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionType - codestring
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- payloadTyperequired, Array of object
The payload type describes the acceptable content that can be communicated on the endpoint.
- codingrequired, Array of object
A reference to a code defined by a terminology system.
- coderequired, string
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Value:any - systemrequired, string
The identification of the code system that defines the meaning of the symbol in the code.
Value:http://terminology.hl7.org/CodeSystem/endpoint-payload-type
- textstring
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
- addressrequired, string
The uri that describes the actual end-point to connect to.
- idstring
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifierArray of object
Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
- extensionArray of Boolean, String, CodeableConcept, Coding
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.
- urlrequired, string
Source of the definition for the extension code - a logical name or a URL.
- valueBooleanboolean
A single value for the extension.
- usestring
The purpose of this identifier.
Possible Values:usual,official,temp,secondary,old (If known) - systemstring
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- valuestring
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
- namestring
A friendly name that this endpoint can be referred to with.
- managingOrganizationobject
The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
Must be a resource of type
Organization.- referencestring
A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with
#and refers to a contained resource.
- payloadMimeTypeArray of string
The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
- identifierArray of NPI or Other
Identifier for the organization that is used to identify the organization across multiple disparate systems.
- systemrequired, string
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Value:http://hl7.org/fhir/sid/us-npi - valuestring
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
- typeArray of object
The kind(s) of organization that this is.
- codingArray of object
A reference to a code defined by a terminology system.
- systemstring
The identification of the code system that defines the meaning of the symbol in the code.
- codestring
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- textstring
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
- aliasArray of string
A list of alternate names that the organization is known as, or was known as in the past.
- telecomArray of object
A contact detail for the organization.
- systemstring
Telecommunications form for contact point - what communications system is required to make use of the contact.
Possible Values:phone,fax,email,pager,url,sms,other - valuestring
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
- addressArray of object
An address for the organization.
- lineArray of string
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
- citystring
The name of the city, town, suburb, village or other community or delivery center.
- statestring
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).
- postalCodestring
A postal code designating a region defined by the postal service.
- countrystring
Country - a nation as commonly understood or generally accepted.
- contactArray of object
Contact for the organization for a certain purpose.
- telecomArray of object
A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
- systemstring
Telecommunications form for contact point - what communications system is required to make use of the contact.
Possible Values:phone,fax,email,pager,url,sms,other - valuestring
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
- usestring
Identifies the purpose for the contact point.
Possible Values:home,work,temp,old,mobile
- endpointArray of object
Technical endpoints providing access to services operated for the organization.
Must be a resource of type
Endpoint.- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- referencestring
A sequence of Unicode characters
- _referenceobject
Extensions for reference
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- typestring
String of characters used to identify a name or a resource
- _typeobject
Extensions for type
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- identifierobject
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- use
The purpose of this identifier.
Possible Values:usual,official,temp,secondary,old - _useobject
Extensions for use
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- typeobject
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- codingArray of object
A reference to a code defined by a terminology system.
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- systemstring
String of characters used to identify a name or a resource
- _systemobject
Extensions for system
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- versionstring
A sequence of Unicode characters
- _versionobject
Extensions for version
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- codestring
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
- _codeobject
Extensions for code
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- displaystring
A sequence of Unicode characters
- _displayobject
Extensions for display
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- userSelectedboolean
Value of "true" or "false"
- _userSelectedobject
Extensions for userSelected
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- textstring
A sequence of Unicode characters
- _textobject
Extensions for text
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- systemstring
String of characters used to identify a name or a resource
- _systemobject
Extensions for system
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- valuestring
A sequence of Unicode characters
- _valueobject
Extensions for value
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- periodobject
Time period during which identifier is/was valid for use.
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- startstring
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
- _startobject
Extensions for start
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- endstring
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
- _endobject
Extensions for end
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- displaystring
A sequence of Unicode characters
- _displayobject
Extensions for display
- idstring
A sequence of Unicode characters
- extensionArray of object
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.
- idstring
A sequence of Unicode characters
- urlstring
String of characters used to identify a name or a resource
- valueBase64Binarystring
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Create new Organization