API Name: get-pcp-list
This API allows request for a specific or full list of PCPs information
Specification
| Endpoint | [baseurl]/Organization/$get-pcp-list |
|---|---|
| Protocol | HTTPS |
| HTTP Method | POST |
| HTTP Header | Content-Type: application/fhir+json |
| Pagination | Yes |
| Target System | Consumer App/ HSG CRM |
API Spec
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| hci-code | 0..1 | string | Search value string for organization identifier HCI Code. |
| active | 1..1 | boolean | Search value boolean for organization status. |
| _count | 0..1 | integer | For pagination use, specify number of records per page, default is 10. |
| _skip | 0..1 | integer | For pagination use, specify number of records to skip, default is 0. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 1..1 | Bundle | Participating Organization |
Request Body
Remarks:
- (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
| profile-Parameter-get-pcp-list (Parameters) | Parameters | There are no (further) constraints on this element Element idParametersShort description Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. The parameters that may be used are defined by the OperationDefinition resource.
| ||||
| id | Σ | 0..0 | id | There are no (further) constraints on this element Element idParameters.idShort description Logical id of this artifact DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..0 | Meta | There are no (further) constraints on this element Element idParameters.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idParameters.implicitRulesShort description A set of rules under which this content was created DefinitionA 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 it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idParameters.languageShort description Language of the resource content DefinitionThe 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). IETF language tag
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| parameter | Σ C | 1..4 | BackboneElement | Element idParameters.parameterShort description n/a Definitionn/a n/a n/a Unordered, Closed, by name(Value) Parameters that can be passed in as input. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | id | There are no (further) constraints on this element Element idParameters.parameter.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | string | There are no (further) constraints on this element Element idParameters.parameter.nameShort description Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ C | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x]Short description If parameter is a data type DefinitionConveys the content if the parameter is a data type. The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueAddress | Address | There are no (further) constraints on this element Data type | ||||
| valueAge | Age | There are no (further) constraints on this element Data type | ||||
| valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||||
| valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| valueCanonical | canonical | There are no (further) constraints on this element Data type | ||||
| valueCode | code | There are no (further) constraints on this element Data type | ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||||
| valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||||
| valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||||
| valueContributor | Contributor | There are no (further) constraints on this element Data type | ||||
| valueCount | Count | There are no (further) constraints on this element Data type | ||||
| valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||||
| valueDate | date | There are no (further) constraints on this element Data type | ||||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| valueDecimal | decimal | There are no (further) constraints on this element Data type | ||||
| valueDistance | Distance | There are no (further) constraints on this element Data type | ||||
| valueDosage | Dosage | There are no (further) constraints on this element Data type | ||||
| valueDuration | Duration | There are no (further) constraints on this element Data type | ||||
| valueExpression | Expression | There are no (further) constraints on this element Data type | ||||
| valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||||
| valueId | id | There are no (further) constraints on this element Data type | ||||
| valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||||
| valueInstant | instant | There are no (further) constraints on this element Data type | ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||||
| valueMeta | Meta | There are no (further) constraints on this element Data type | ||||
| valueMoney | Money | There are no (further) constraints on this element Data type | ||||
| valueOid | oid | There are no (further) constraints on this element Data type | ||||
| valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| valueReference | Reference | There are no (further) constraints on this element Data type | ||||
| valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||||
| valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||||
| valueSignature | Signature | There are no (further) constraints on this element Data type | ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueTime | time | There are no (further) constraints on this element Data type | ||||
| valueTiming | Timing | There are no (further) constraints on this element Data type | ||||
| valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||||
| valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||||
| valueUri | uri | There are no (further) constraints on this element Data type | ||||
| valueUrl | url | There are no (further) constraints on this element Data type | ||||
| valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||||
| valueUuid | uuid | There are no (further) constraints on this element Data type | ||||
| resource | Σ C | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| hci-code | Σ C | 0..1 | BackboneElement | Element idParameters.parameter:hci-codeShort description n/a Definitionn/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:hci-code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:hci-code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:hci-code.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | stringFixed Value | Element idParameters.parameter:hci-code.nameShort description n/a DefinitionName of parameter n/a Fixed value "hci-code" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
hci-codeMappings
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:hci-code.value[x]Short description n/a DefinitionSearch value string for organization identifier HCI Code n/a Sample value: "18M123" The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueString | string | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:hci-code.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:hci-code.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| active | Σ C | 1..1 | BackboneElement | Element idParameters.parameter:activeShort description n/a Definitionn/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:active.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:active.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:active.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | stringFixed Value | Element idParameters.parameter:active.nameShort description n/a DefinitionName of parameter n/a Fixed value "active" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
activeMappings
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:active.value[x]Short description n/a DefinitionSearch value boolean for pcp status n/a Sample value: true The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueBoolean | boolean | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:active.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:active.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| _count | Σ C | 0..1 | BackboneElement | Element idParameters.parameter:_countShort description n/a DefinitionSearch value boolean for pcp status n/a Sample value: true The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:_count.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:_count.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:_count.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | stringFixed Value | Element idParameters.parameter:_count.nameShort description n/a DefinitionName of parameter n/a Fixed value "_count" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
_countMappings
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:_count.value[x]Short description n/a DefinitionFor pagination use, specify number of records per page, default is 10 n/a Sample value: 10 The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueInteger | integer | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:_count.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:_count.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| _skip | Σ C | 0..1 | BackboneElement | Element idParameters.parameter:_skipShort description n/a DefinitionFor pagination use, specify number of records to skip, default is 0 n/a Sample value: 1 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:_skip.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:_skip.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idParameters.parameter:_skip.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | stringFixed Value | Element idParameters.parameter:_skip.nameShort description n/a DefinitionName of parameter n/a Fixed value "_skip" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
_skipMappings
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:_skip.value[x]Short description n/a DefinitionFor pagination use, specify number of records to skip, default is 0 n/a Sample value: 1 The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueInteger | integer | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:_skip.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:_skip.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Successful Response
Remarks:
- (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
- The details of the following elements contain an 'Examples' section that is automatically generated and should be ignored.
Organization.identifier.systemOrganization.identifier.valueOrganization.address.typeOrganization.address.textOrganization.address.lineOrganization.address.postalCode
| profile-Bundle-get-pcp-list (Bundle) | C | Bundle | There are no (further) constraints on this element Element idBundleShort description Contains a collection of resources DefinitionA container for a collection of resources.
| |||
| id | Σ | 1..1 | id | Element idBundle.idShort description n/a Definitionn/a n/a Sample Value: "63d098ea8a0c1662f6fab32197285c82" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 1..1 | Meta | Element idBundle.metaShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idBundle.meta.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idBundle.meta.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| versionId | Σ | 0..0 | id | Element idBundle.meta.versionIdShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastUpdated | Σ | 1..1 | instant | Element idBundle.meta.lastUpdatedShort description n/a Definitionn/a n/a Sample Value: "2023-01-25T10:50:18.973+08:00" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source | Σ | 0..0 | uri | Element idBundle.meta.sourceShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | Σ | 0..0 | canonical(StructureDefinition) | Element idBundle.meta.profileShort description n/a Definitionn/a n/a n/a canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| security | Σ | 0..0 | CodingBinding | Element idBundle.meta.securityShort description n/a Definitionn/a n/a n/a All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| tag | Σ | 0..0 | Coding | Element idBundle.meta.tagShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | Element idBundle.implicitRulesShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | Element idBundle.languageShort description n/a Definitionn/a n/a n/a IETF language tag
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| identifier | Σ | 0..0 | Identifier | Element idBundle.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | codeBindingFixed Value | Element idBundle.typeShort description n/a Definitionn/a n/a n/a Indicates the purpose of a bundle - how it is intended to be used. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
searchsetMappings
| ||
| timestamp | Σ | 0..0 | instant | Element idBundle.timestampShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| total | Σ C | 1..1 | unsignedInt | Element idBundle.totalShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-1 Constraints
| ||
| link | Σ | 0..* | BackboneElement | Element idBundle.linkShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idBundle.link.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idBundle.link.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | Element idBundle.link.modifierExtensionShort description n/a Alternate namesextensions, user content, modifiers Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relation | Σ | 1..1 | string | Element idBundle.link.relationShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 1..1 | uri | Element idBundle.link.urlShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| entry | Σ C | 0..* | BackboneElement | Element idBundle.entryShort description n/a Definitionn/a n/a n/a Unordered, Open, by fullUrl(Pattern) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | id | There are no (further) constraints on this element Element idBundle.entry.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. | ||
| fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.fullUrlShort description URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| resource | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.resourceShort description A resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
| ||
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idBundle.entry.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.search.modeShort description match | include | outcome - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| request | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idBundle.entry.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| method | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1MB in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatchShort description For managing cache currency DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idBundle.entry.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
| ||
| participatingPcp | Σ C | 0..* | BackboneElement | Element idBundle.entry:participatingPcpShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. | ||
| fullUrl | Σ | 1..1 | uriPattern | Element idBundle.entry:participatingPcp.fullUrlShort description n/a DefinitionFixed URL pattern for participating organization entries n/a Sample Value: "https://pophealth.healthdxp.com/Organization/8C1978AD05D44A56A81BE715930EF399" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/StructureDefinition/Organization-pophealthMappings
| ||
| resource | Σ C | 1..1 | profile-Organization-get-pcp-list-participatingPcp | Element idBundle.entry:participatingPcp.resourceShort description n/a DefinitionBundle of Resource Type Organization with type = GP or Poly n/a n/a profile-Organization-get-pcp-list-participatingPcp Constraints
| ||
| search | Σ C | 0..0 | BackboneElement | Element idBundle.entry:participatingPcp.searchShort description n/a Definitionn/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 Constraints
| ||
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 Constraints
| ||
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:participatingPcp.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 Constraints
| ||
| primaryPcp | Σ C | 0..* | BackboneElement | Element idBundle.entry:primaryPcpShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. | ||
| fullUrl | Σ | 1..1 | uriPattern | Element idBundle.entry:primaryPcp.fullUrlShort description n/a DefinitionFixed URL pattern for organization entries n/a Sample Value: "https://pophealth.healthdxp.com/Organization/9D20933339534103AFAD7DC106FF9D54" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/StructureDefinition/Organization-pophealth-get-pcp-list-primaryMappings
| ||
| resource | Σ C | 1..1 | profile-Organization-get-pcp-list-primaryPcp | Element idBundle.entry:primaryPcp.resourceShort description n/a DefinitionOrganization such as Clinic, Poly, or Hosptial that are part of the organization group n/a Reference organization profile-Organization-get-pcp-list-primaryPcp Constraints
| ||
| search | Σ C | 0..0 | BackboneElement | Element idBundle.entry:primaryPcp.searchShort description n/a Definitionn/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 Constraints
| ||
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 Constraints
| ||
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:primaryPcp.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 Constraints
| ||
| organizationAffiliation | Σ C | 0..* | BackboneElement | Element idBundle.entry:organizationAffiliationShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idBundle.entry:organizationAffiliation.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:organizationAffiliation.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:organizationAffiliation.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:organizationAffiliation.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. | ||
| fullUrl | Σ | 1..1 | uriPattern | Element idBundle.entry:organizationAffiliation.fullUrlShort description n/a DefinitionFixed URL pattern for organization affiliation entries n/a Sample Value: "https://pophealth.healthdxp.com/OrganizationAffiliation/8D62B89E5C374CDBB8CC6B848CAB5746" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/StructureDefinition/Organization-pophealth-get-pcp-list-orgAffiliationMappings
| ||
| resource | Σ C | 1..1 | profile-Organization-get-pcp-list-organizationAffiliation | Element idBundle.entry:organizationAffiliation.resourceShort description n/a DefinitionBundle of resource type Organisation Affiliation n/a n/a profile-Organization-get-pcp-list-organizationAffiliation Constraints
| ||
| search | Σ C | 0..0 | BackboneElement | Element idBundle.entry:organizationAffiliation.searchShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 Constraints
| ||
| request | Σ C | 0..0 | BackboneElement | Element idBundle.entry:organizationAffiliation.requestShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 Constraints
| ||
| response | Σ C | 0..0 | BackboneElement | Element idBundle.entry:organizationAffiliation.responseShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 Constraints
| ||
| signature | Σ | 0..0 | Signature | Element idBundle.signatureShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| profile-Organization-get-pcp-list-primaryPcp (Organization) | C | profile-Organization-get-pcp-list-base | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA 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. profile-Organization-get-pcp-list-base Constraints
| |||
| id | Σ | 1..1 | id | There are no (further) constraints on this element Element idOrganization.idShort description Logical id of this artifact DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idOrganization.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.meta.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.meta.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.meta.versionIdShort description n/a DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idOrganization.meta.lastUpdatedShort description n/a DefinitionWhen the resource last changed - e.g. when the version changed. Sample value: " The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source | Σ | 0..0 | uri | There are no (further) constraints on this element Element idOrganization.meta.sourceShort description Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | Σ | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idOrganization.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| security | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idOrganization.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| tag | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idOrganization.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.meta.tag.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.meta.tag.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.meta.tag.systemShort description n/a DefinitionThe identification of the code system that defines the meaning of the symbol in the code. n/a Sample value: "http://ihis.sg/coding/correlationid" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.meta.tag.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idOrganization.meta.tag.codeShort description n/a DefinitionA 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). Need to refer to a particular code in the system. Sample value: "6375b1bbac7792e855e25860d857694c" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.meta.tag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.meta.tag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idOrganization.implicitRulesShort description A set of rules under which this content was created DefinitionA 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 it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idOrganization.languageShort description Language of the resource content DefinitionThe 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). IETF language tag
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idOrganization.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idOrganization.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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 | C | 0..0 | Extension | Element idOrganization.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ C | 1..* | Identifier | Element idOrganization.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier.systemShort description n/a DefinitionThe namespace for the identifier value, HCI Code n/a Fixed Value : "http://ihis.sg/identifier/hci-code" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/identifier/hci-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | Element idOrganization.identifier.valueShort description n/a DefinitionCluster / PCN code n/a Sample Value : "NHG" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..0 | Period | Element idOrganization.identifier.periodShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 1..1 | boolean | Element idOrganization.activeShort description n/a DefinitionWhether the organization's record is still in active use. n/a Sample Value: "true" This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | CodeableConcept | Element idOrganization.typeShort description n/a Definitionn/a n/a n/a Used to categorize the organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.type.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganization.type.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | Element idOrganization.type.codingShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.type.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.type.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.type.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-organization-type" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/ValueSet/hsg-organization-typeMappings
| ||
| version | Σ | 0..1 | string | Element idOrganization.type.coding.versionShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.type.coding.codeShort description n/a DefinitionSymbol in syntax defined by the system Internal code to represent the organization type. It shall be one of the code defined in valueset http://ihis.sg/ValueSet/hsg-organization-type n/a Sample Value : "GP" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Sample Value : "General Practitioner" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 1..1 | string | Element idOrganization.nameShort description n/a DefinitionCluster / PCN Name n/a Sample Value: "Assurance PCN Pte. Ltd." The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| alias | 0..0 | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| telecom | C | 0..0 | ContactPoint | Element idOrganization.telecomShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints
| ||
| address | C | 0..0 | Address | Element idOrganization.addressShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-2 Constraints
| ||
| partOf | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | 0..0 | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endpoint | C | 0..0 | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| profile-Organization-get-pcp-list-participatingPcp (Organization) | C | profile-Organization-get-pcp-list-base | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA 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. profile-Organization-get-pcp-list-base Constraints
| |||
| id | Σ | 1..1 | id | There are no (further) constraints on this element Element idOrganization.idShort description Logical id of this artifact DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idOrganization.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.meta.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.meta.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.meta.versionIdShort description n/a DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idOrganization.meta.lastUpdatedShort description n/a DefinitionWhen the resource last changed - e.g. when the version changed. Sample value: " The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source | Σ | 0..0 | uri | There are no (further) constraints on this element Element idOrganization.meta.sourceShort description Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | Σ | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idOrganization.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| security | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idOrganization.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| tag | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idOrganization.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.meta.tag.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.meta.tag.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.meta.tag.systemShort description n/a DefinitionThe identification of the code system that defines the meaning of the symbol in the code. n/a Sample value: "http://ihis.sg/coding/correlationid" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.meta.tag.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idOrganization.meta.tag.codeShort description n/a DefinitionA 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). Need to refer to a particular code in the system. Sample value: "6375b1bbac7792e855e25860d857694c" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.meta.tag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.meta.tag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idOrganization.implicitRulesShort description A set of rules under which this content was created DefinitionA 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 it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idOrganization.languageShort description Language of the resource content DefinitionThe 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). IETF language tag
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idOrganization.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idOrganization.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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 | C | 3..5 | Extension | Element idOrganization.extensionShort description n/a Alternate namesextensions, user content DefinitionAdditional data element required by Healthier SG n/a The extension is in the format of key/value pair, where the key is specified in 'url' attribute, and the value is specified in the 'value[Type]' attribute, the Type can be Coding, String, Date or others depending on the definition specified in Data Type column W. All the extension url is be prefixed with "http://ihis.sg/extension" and followed by friendly short name Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| capacity-status | C | 1..1 | Extension(CodeableConcept) | Element idOrganization.extension:capacity-statusShort description n/a Alternate namesextensions, user content DefinitionExtension of capacity status n/a Fixed value: "http://ihis.sg/extension/capacity-status" http://ihis.sg/extension/capacity-status ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.extension:capacity-status.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.urlShort description n/a DefinitionExtension of capacity status n/a Fixed Value: "http://ihis.sg/extension/capacity-status" http://ihis.sg/extension/capacity-statusMappings
| |||
| value[x] | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x]Short description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | id | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].codingShort description n/a DefinitionGrouping of coding n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.systemShort description n/a DefinitionThe terminology system of the coding. n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-capacity-status" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/extension/capacity-statusMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.codeShort description n/a DefinitionValue code: available / full n/a Sample Value : "available" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.displayShort description n/a DefinitionValue code: Available / Full n/a Sample Value : "Available" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.extension:capacity-status.value[x].textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| enrollment-capacity | C | 1..1 | Extension(integer) | Element idOrganization.extension:enrollment-capacityShort description n/a Alternate namesextensions, user content DefinitionExtension of enrollment capacity n/a Fixed value: "http://ihis.sg/extension/enrollment-capacity" http://ihis.sg/extension/enrollment-capacity ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.extension:enrollment-capacity.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:enrollment-capacity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:enrollment-capacity.urlShort description n/a DefinitionExtension of enrollment capacity n/a Fixed Value: "http://ihis.sg/extension/enrollment-capacity" http://ihis.sg/extension/enrollment-capacityMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idOrganization.extension:enrollment-capacity.value[x]Short description n/a DefinitionEnrollment Capacity (Default Value: 9999) n/a Sample Value: "500" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| available-capacity | C | 0..1 | Extension(integer) | Element idOrganization.extension:available-capacityShort description n/a Alternate namesextensions, user content DefinitionExtension of available capacity n/a Fixed value: "http://ihis.sg/extension/available-capacity" http://ihis.sg/extension/available-capacity ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.extension:available-capacity.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:available-capacity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:available-capacity.urlShort description n/a DefinitionExtension of available capacity n/a Fixed Value: "http://ihis.sg/extension/available-capacity" http://ihis.sg/extension/available-capacityMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idOrganization.extension:available-capacity.value[x]Short description n/a DefinitionAvailable capacity n/a Sample Value: "234" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| org-opening-hours | C | 1..1 | Extension(string) | Element idOrganization.extension:org-opening-hoursShort description n/a Alternate namesextensions, user content DefinitionExtension of opening hours n/a Fixed value: "http://ihis.sg/extension/org-opening-hours" http://ihis.sg/extension/org-opening-hours ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.extension:org-opening-hours.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:org-opening-hours.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:org-opening-hours.urlShort description n/a DefinitionExtension of organization's opening hours n/a Fixed Value: "http://ihis.sg/extension/org-opening-hours" http://ihis.sg/extension/org-opening-hoursMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idOrganization.extension:org-opening-hours.value[x]Short description n/a DefinitionOrganization's opening hours in string n/a Sample Value : "Daily 9am - 10pm" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| organization-status | C | 0..1 | Extension(CodeableConcept) | Element idOrganization.extension:organization-statusShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a http://ihis.sg/extension/organization-status ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.extension:organization-status.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:organization-status.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:organization-status.urlShort description n/a DefinitionExtension of organization's status n/a Fixed Value: "http://ihis.sg/extension/organization-status" http://ihis.sg/extension/organization-statusMappings
| |||
| value[x] | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x]Short description n/a DefinitionOrganization status n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].codingShort description n/a DefinitionGrouping of coding n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.systemShort description n/a DefinitionThe terminology system of the coding. n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-organization-status" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/ValueSet/hsg-organization-statusMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.codeShort description n/a DefinitionCode value of organization status, complete/provisional n/a Sample Value : "complete" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.displayShort description n/a DefinitionDisplay value of organization status, Complete/Provisional n/a Sample Value : "Complete" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.extension:organization-status.value[x].textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ C | 1..* | Identifier | Element idOrganization.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | Element idOrganization.identifier.useShort description n/a DefinitionThe purpose of this identifier n/a Sample Value: "official" (official: The identifier considered to be most trusted for the identification of this item. old:The identifier id no longer considered valid, but may be relevant for search purposes. E.g. Changes to identifier schemes, account merges, etc. ) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier.systemShort description n/a DefinitionNamespace of the organization identifier to ensure global uniqueness n/a Fixed Value : "http://ihis.sg/identifier/hci-code" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/identifier/hci-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | Element idOrganization.identifier.valueShort description n/a DefinitionHCI code of each organization n/a Sample Value : "123H01" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | Element idOrganization.identifier.periodShort description n/a DefinitionValid period of HCI code n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.identifier.period.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.identifier.period.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| start | Σ C | 1..1 | dateTime | Element idOrganization.identifier.period.startShort description n/a DefinitionHCI code start datetime n/a Sample value: "2022-08-22T12:00:12+08:00" The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
| end | Σ C | 0..1 | dateTime | Element idOrganization.identifier.period.endShort description n/a DefinitionHCI code end datetime n/a Sample value: "2023-08-22T12:00:12+08:00" If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 1..1 | boolean | Element idOrganization.activeShort description n/a DefinitionStatus of clinic n/a Sample Value: true This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | CodeableConcept | Element idOrganization.typeShort description n/a DefinitionType of service that may be delivered or performed n/a n/a Used to categorize the organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idOrganization.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.type.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.type.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.type.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-organization-type" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/ValueSet/hsg-organization-typeMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.type.coding.codeShort description n/a DefinitionSymbol in syntax defined by the system Internal code to represent the organization type. It shall be one of the code defined in valueset http://ihis.sg/ValueSet/hsg-organization-type n/a Sample Value : "GP" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Sample Value : "General Practitioner" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOrganization.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 1..1 | string | Element idOrganization.nameShort description n/a DefinitionOrganization name n/a Sample Value: "Clinic ABC" The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| alias | 0..0 | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| telecom | C | 0..* | ContactPoint | Element idOrganization.telecomShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.telecom.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.telecom.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 0..1 | codeBinding | Element idOrganization.telecom.systemShort description n/a DefinitionOrganization Contact n/a Sample Value: "phone", "email" The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
| value | Σ | 0..1 | string | Element idOrganization.telecom.valueShort description n/a DefinitionThe actual contact point details n/a Sample Value: 98765432", "helpdesk@parkway.com" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idOrganization.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| rank | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idOrganization.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idOrganization.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | C | 1..1 | Address | Element idOrganization.addressShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1, org-2 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.address.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idOrganization.address.useShort description home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address (home / work / etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
| type | Σ | 1..1 | codeBinding | Element idOrganization.address.typeShort description n/a DefinitionAddress type n/a Sample Value: both The type of an address (physical / postal). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
| text | Σ | 1..1 | string | Element idOrganization.address.textShort description n/a DefinitionFull address n/a eg: "#01-01, BLK 100, COMPASSVALE ROAD, S555222, Singapore" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132Mappings
| ||
| line | Σ | 1..* | string | Element idOrganization.address.lineShort description n/a DefinitionStreet name, number, direction & P.O. Box etc. n/a Combination of Block Number, Street Name, Floor Number, Unit Number, Building Name line[0] - Block number line[1] - Street name line[2] - Floor Number line[3] - Unit Number line[4] - Building Name e.g. 888, Serangoon Street 81, 7, #11-98, The Trilliant The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetMappings
| ||
| city | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonMappings
| ||
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonMappings
| ||
| state | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-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). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| postalCode | Σ | 1..1 | string | Element idOrganization.address.postalCodeShort description n/a Alternate namesZip Definitionpostal code of the address n/a eg: "544267" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132Mappings
| ||
| country | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idOrganization.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
| ||
| partOf | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | 1..1 | BackboneElement | Element idOrganization.contactShort description n/a DefinitionPrimary contact detail n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.contact.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 1..1 | Extension | Element idOrganization.contact.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contactMcrNumber | C | 1..1 | Extension(string) | Element idOrganization.contact.extension:contactMcrNumberShort description n/a Alternate namesextensions, user content Definitiondoctor's MCR extension n/a Fixed Value: "http://ihis.sg/extension/contact-mcr-number" http://ihis.sg/extension/contact-mcr-number ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganization.contact.extension:contactMcrNumber.idShort description n/a DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension:contactMcrNumber.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.contact.extension:contactMcrNumber.urlShort description n/a Definitiondoctor's MCR extension n/a Fixed Value: "http://ihis.sg/extension/contact-mcr-number" http://ihis.sg/extension/contact-mcr-numberMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idOrganization.contact.extension:contactMcrNumber.value[x]Short description n/a DefinitionValue of the extension n/a Sample Value: "M12345C" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The purpose for which you would contact a contact party. ContactEntityType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| name | 0..1 | HumanName | Element idOrganization.contact.nameShort description n/a Definitiondoctor's name n/a Sample Value: "Lim Si Yuan Daniel" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idOrganization.contact.name.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.contact.name.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idOrganization.contact.name.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | Element idOrganization.contact.name.textShort description n/a Definitiondoctor's name n/a Sample Value: "Lim Si Yuan Daniel" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| family | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.contact.name.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| given | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.contact.name.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.contact.name.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.contact.name.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idOrganization.contact.name.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | C | 0..0 | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | 0..0 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Note: 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endpoint | C | 0..0 | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| profile-Organization-get-pcp-list-organizationAffiliation (OrganizationAffiliation) | C | OrganizationAffiliation | There are no (further) constraints on this element Element idOrganizationAffiliationShort description Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship DefinitionDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.
| |||
| id | Σ | 0..0 | id | Element idOrganizationAffiliation.idShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganizationAffiliation.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | Element idOrganizationAffiliation.implicitRulesShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | Element idOrganizationAffiliation.languageShort description n/a Definitionn/a n/a n/a IETF language tag
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..0 | Narrative | Element idOrganizationAffiliation.textShort description n/a Alternate namesnarrative, html, xhtml, display Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 0..0 | Resource | Element idOrganizationAffiliation.containedShort description n/a Alternate namesinline resources, anonymous resources, contained resources Definitionn/a n/a n/a
| ||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..0 | Extension | Element idOrganizationAffiliation.modifierExtensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..0 | Identifier | Element idOrganizationAffiliation.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ | 1..1 | boolean | Element idOrganizationAffiliation.activeShort description n/a DefinitionStatus n/a Sample Value: true This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 1..1 | Period | Element idOrganizationAffiliation.periodShort description n/a DefinitionThe affiliation period n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganizationAffiliation.period.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.period.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| start | Σ C | 1..1 | dateTime | Element idOrganizationAffiliation.period.startShort description n/a DefinitionAffiliation start date n/a Sample value: "2022-08-22" The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
| end | Σ C | 0..1 | dateTime | Element idOrganizationAffiliation.period.endShort description n/a DefinitionAffiliation end date n/a Sample value: "2023-08-22" If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
| organization | Σ C | 1..1 | Reference(Organization) | Element idOrganizationAffiliation.organizationShort description n/a DefinitionReference of the organization group n/a Reference organization The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganizationAffiliation.organization.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.organization.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | string | Element idOrganizationAffiliation.organization.referenceShort description n/a DefinitionReference of the organization group n/a Sample Value : "https://pophealth.healthdxp.com/Organization/3C53404B2C114230BD4DB37B4AF6593C" The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | Element idOrganizationAffiliation.organization.typeShort description n/a DefinitionIndicate that the identifier below is for Organization n/a Fixed value: "Organization" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..0 | Identifier | Element idOrganizationAffiliation.organization.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..0 | string | Element idOrganizationAffiliation.organization.displayShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| participatingOrganization | Σ C | 1..1 | Reference(Organization) | Element idOrganizationAffiliation.participatingOrganizationShort description n/a DefinitionOrganization such as Clinic, Poly, or Hospital that are part of the organization group n/a Reference organization The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganizationAffiliation.participatingOrganization.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.participatingOrganization.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | string | Element idOrganizationAffiliation.participatingOrganization.referenceShort description n/a DefinitionReference value of organization n/a Sample Value : "https://pophealth.healthdxp.com/Organization/0CD470896E55426D80EC8F34AFE3A0E9" The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | Element idOrganizationAffiliation.participatingOrganization.typeShort description n/a DefinitionIndicate that the identifier below is for Organization n/a Fixed value: "Organization" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..0 | Identifier | Element idOrganizationAffiliation.participatingOrganization.identifierShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..0 | string | Element idOrganizationAffiliation.participatingOrganization.displayShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| network | Σ C | 0..0 | Reference(Organization) | Element idOrganizationAffiliation.networkShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..* | CodeableConcept | Element idOrganizationAffiliation.codeShort description n/a DefinitionThe role of the participating organization play n/a n/a The role the participating organization providing services to the primary organization. OrganizationAffiliationRole (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganizationAffiliation.code.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.code.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | Element idOrganizationAffiliation.code.codingShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | Element idOrganizationAffiliation.code.coding.idShort description n/a Definitionn/a n/a n/a
| |||
| extension | C | 0..0 | Extension | Element idOrganizationAffiliation.code.coding.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganizationAffiliation.code.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-organization-affiliation-type" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/ValueSet/hsg-organization-affiliation-typeMappings
| ||
| version | Σ | 0..0 | string | Element idOrganizationAffiliation.code.coding.versionShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | Element idOrganizationAffiliation.code.coding.codeShort description n/a DefinitionSymbol in syntax defined by the system n/a Sample Value : "Cluster-PCP" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | Element idOrganizationAffiliation.code.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Sample Value : "Cluster-PCP" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | Element idOrganizationAffiliation.code.coding.userSelectedShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | Element idOrganizationAffiliation.code.textShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specialty | Σ | 0..0 | CodeableConceptBinding | Element idOrganizationAffiliation.specialtyShort description n/a Definitionn/a n/a n/a Specific specialty associated with the participating organization. PracticeSettingCodeValueSet (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ C | 0..0 | Reference(Location) | Element idOrganizationAffiliation.locationShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| healthcareService | C | 0..0 | Reference(HealthcareService) | Element idOrganizationAffiliation.healthcareServiceShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | Σ C | 0..0 | ContactPoint | Element idOrganizationAffiliation.telecomShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| endpoint | C | 0..0 | Reference(Endpoint) | Element idOrganizationAffiliation.endpointShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Error Response
Click here for General API Error Handling
Custom Error Codes
Refer to Custom Error Codes for the list of custom error codes specific to this API.