API Name: put-pcp

This API allows capture new and updated HSG PCP(s) with cluster and PCN information into HSAR.

Specification

Endpoint	[baseurl]/Organization/$put-pcp
Protocol	HTTPS
HTTP Method	POST
HTTP Header	Content-Type: application/fhir+json
Pagination	No
Target System	Consumer / Provider Apps

API Spec

API Spec

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
reason	1..1	string	The valueset to indicate the reason of the change. Either "add" or "update".
pcp	1..1	Organization	The ogranization information.
cluster-relationship	0..1	OrganizationAffiliation	The organization relationship with Cluster. Mandatory when the reason is 'add'.
pcn-relationship	0..1	OrganizationAffiliation	The organization relationship with PCN. Mandatory when the reason is 'add'

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	The outcome of the opreation.

Request Body

profile-Parameter-put-pcp-add (Parameters)

Parameters

There are no (further) constraints on this element

Element id

Parameters

Short description

Operation Request or Response

Definition

This 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.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

Parameters

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a
w5: infrastructure.exchange

0..0

There are no (further) constraints on this element

Element id

Parameters.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

parameter

Σ C

4..4

BackboneElement

Element id

Parameters.parameter

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Slicing

Unordered, Open, by name(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Mappings

rim: n/a

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

value[x]

Σ C

0..1

Element id

Parameters.parameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

valueCode

code

Data type

code

resource

Σ C

0..1

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

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.

Data type

Resource

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Mappings

rim: Entity. Role, or Act

part

0..1

see (parameter)

Element id

Parameters.parameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

reasonParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:reasonParameter

Short description

n/a

Definition

"reason" parameter

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
reason-parameter-exists: reason
(where(name='reason').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:reasonParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "Reason"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

reason

Examples
Fixed Value

reason

Mappings

rim: n/a

value[x]

Σ C

1..1

Binding

Element id

Parameters.parameter:reasonParameter.value[x]

Short description

n/a

Definition

The valueset to indicate the reason of the change - http://ihis.sg/ValueSet/hsg-put-pcp-reason

Requirements

n/a

Comments

Sample Values: "add" "update"

Binding

hsg-put-pcp-reason (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

valueCode

code

Data type

code

resource

Σ C

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Resource

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Mappings

rim: Entity. Role, or Act

part

0..0

see (parameter)

Element id

Parameters.parameter:reasonParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

pcpParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:pcpParameter

Short description

n/a

Definition

"pcp" parameter

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
pcp-parameter-exists: pcp parameter
(where(name='pcp').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:pcpParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "pcp"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

pcp

Examples
Fixed Value

pcp

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:pcpParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-Organization-put-pcp-add

Element id

Parameters.parameter:pcpParameter.resource

Short description

n/a

Definition

The organization resource

Requirements

n/a

Comments

n/a

Data type

profile-Organization-put-pcp-add

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0

Mappings

rim: Entity. Role, or Act
v2: (also see master files messages)
rim: Organization(classCode=ORG, determinerCode=INST)
servd: Organization
w5: administrative.group

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

1..*

Extension

Element id

Parameters.parameter:pcpParameter.resource.extension

Short description

n/a

Alternate names

extensions, user content

Definition

Extension element of enrollment capacity

Requirements

n/a

Comments

n/a

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

EnrollmentCapacity

1..1

Extension(integer)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity

Short description

n/a

Alternate names

extensions, user content

Definition

Extension element of enrollment capacity

Requirements

n/a

Comments

n/a

Data type

Extension(integer)

Extension URL

http://ihis.sg/extension/enrollment-capacity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity.url

Short description

n/a

Definition

Extension of enrollment capacity

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/extension/enrollment-capacity"

Data type

uri

Fixed value

http://ihis.sg/extension/enrollment-capacity

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity.value[x]

Short description

n/a

Definition

Enrollment Capacity (Default Value: 9999)

Requirements

n/a

Comments

Sample Value : 500

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Minimum value

Examples
Sample Value

Mappings

rim: n/a
rim: N/A

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

Σ C

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Fixed Value

http://ihis.sg/identifier/hci-code

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.value

Short description

n/a

Definition

The PCP's HCI code

Requirements

n/a

Comments

Sample Value : "HCI-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

HCI-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.active

Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
v2: No equivalent in HL7 v2
rim: .status
servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

type

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.type

Short description

Kind of organization

Definition

The kind(s) of organization that this is.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

CodeableConcept

Binding

Used to categorize the organization.

OrganizationType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

name

Σ C

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.name

Short description

n/a

Definition

The name of the PCP

Requirements

n/a

Comments

Mandatory when the reason is "add". Sample Value : "HSG Clinic"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

HSG Clinic

Mappings

rim: n/a
v2: XON.1
rim: .name
servd: .PreferredName/Name

alias

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.alias

Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .name

telecom

0..1

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

If this section does not present when Reason is add, system will auto populate this section with empty string "" as email address.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-3

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

Σ C

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.system

Short description

n/a

Definition

Organization Contact

Requirements

n/a

Comments

Fixed Value: "email"

Data type

code

Binding

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

email

Examples
Fixed Value

email

Mappings

rim: n/a
v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

Σ C

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.value

Short description

n/a

Definition

The email address

Requirements

n/a

Comments

Sample Value: "helpdesk@parkway.com"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
organization-email-validation: Email address does not follow the format.
$this.trim().length() = 0 or $this.toString().matches('^[a-zA-Z0-9][a-zA-Z0-9._%+-]*@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$')
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Examples
Sample Value

helpdesk@parkway.com

Mappings

rim: n/a
v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..0

positiveInt

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies 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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: n/a

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..0

Address

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.address

Short description

An address for the organization

Definition

An address for the organization.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XAD
rim: AD
servd: Address
v2: ORC-23?
rim: .address
servd: ./PrimaryAddress and ./OtherAddresses

partOf

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.partOf

Short description

The organization of which this organization forms a part

Definition

The organization of which this organization forms a part.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: No equivalent in HL7 v2
rim: .playedBy[classCode=Part].scoper
servd: n/a

contact

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.contact

Short description

Contact for the organization for a certain purpose

Definition

Contact for the organization for a certain purpose.

Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .contactParty

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:pcpParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

clusterRelationshipParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:clusterRelationshipParameter

Short description

n/a

Definition

"cluster-relationship" parameter

Requirements

n/a

Comments

Mandatory when the reason is "add"

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
cluster-relationship-parameter-exists: Cluster Relaionship Exists
(where(name='cluster-relationship').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:clusterRelationshipParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "cluster-relationship"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

cluster-relationship

Examples
Fixed Value

cluster-relationship

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:clusterRelationshipParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-OrganizationAffiliation-put-pcp

Element id

Parameters.parameter:clusterRelationshipParameter.resource

Short description

n/a

Definition

The organization Affilication resource

Requirements

n/a

Comments

n/a

Data type

profile-OrganizationAffiliation-put-pcp

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period

Short description

n/a

Definition

The period during the clinic is affiliated with the cluster

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization

Short description

n/a

Definition

Reference of the related cluster

Requirements

n/a

Comments

Reference related cluster

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.value

Short description

n/a

Definition

The cluster code

Requirements

n/a

Comments

Sample Value : "Cluster-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

cluster-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

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.

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:clusterRelationshipParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

pcnRelationshipParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:pcnRelationshipParameter

Short description

n/a

Definition

"pcn-relationship" parameter

Requirements

n/a

Comments

Mandatory when the reason is "add"

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
pcn-relationship-parameter-exists: PCN relationship exists
(where(name='pcn-relationship').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:pcnRelationshipParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "pcn-relationship"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

pcn-relationship

Examples
Fixed Value

pcn-relationship

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:pcnRelationshipParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-OrganizationAffiliation-put-pcp-pcn

Element id

Parameters.parameter:pcnRelationshipParameter.resource

Short description

n/a

Definition

The organization Affilication resource

Requirements

n/a

Comments

n/a

Data type

profile-OrganizationAffiliation-put-pcp-pcn

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period

Short description

n/a

Definition

The period during the clinic is affiliated with the PCN

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization

Short description

n/a

Definition

Reference of the related PCN

Requirements

n/a

Comments

Reference related PCN

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.value

Short description

n/a

Definition

The PCN code

Requirements

n/a

Comments

Sample Value : "PCN-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

PCN-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:pcnRelationshipParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

profile-Parameter-put-pcp-update (Parameters)

Parameters

There are no (further) constraints on this element

Element id

Parameters

Short description

Operation Request or Response

Definition

This 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.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

Parameters

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a
w5: infrastructure.exchange

0..0

There are no (further) constraints on this element

Element id

Parameters.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

parameter

Σ C

2..4

BackboneElement

Element id

Parameters.parameter

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Slicing

Unordered, Open, by name(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
parameter-name-allowed-values: Parameter name allowed values: ('reason' | 'pcp' | 'cluster-relationship' | 'pcn-relationship')
($this.name in ('reason' | 'pcp' | 'cluster-relationship' | 'pcn-relationship'))

Mappings

rim: n/a

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

value[x]

Σ C

0..1

Element id

Parameters.parameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

valueCode

code

Data type

code

resource

Σ C

0..1

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Resource

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Mappings

rim: Entity. Role, or Act

part

0..1

see (parameter)

Element id

Parameters.parameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

reasonParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:reasonParameter

Short description

n/a

Definition

"reason" parameter

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
reason-parameter-exists: reason
(where(name='reason').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:reasonParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "Reason"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

reason

Examples
Fixed Value

Reason

Mappings

rim: n/a

value[x]

Σ C

1..1

Binding

Element id

Parameters.parameter:reasonParameter.value[x]

Short description

n/a

Definition

The valueset to indicate the reason of the change - http://ihis.sg/ValueSet/hsg-put-pcp-reason

Requirements

n/a

Comments

Sample Values: "add" "update"

Binding

hsg-put-pcp-reason (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

valueCode

code

Data type

code

resource

Σ C

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:reasonParameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Resource

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Mappings

rim: Entity. Role, or Act

part

0..0

see (parameter)

Element id

Parameters.parameter:reasonParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

pcpParameter

Σ C

1..1

BackboneElement

Element id

Parameters.parameter:pcpParameter

Short description

n/a

Definition

"pcp" parameter

Requirements

n/a

Comments

n/a

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
pcp-parameter-exists: pcp parameter
(where(name='pcp').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:pcpParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "pcp"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

pcp

Examples
Fixed Value

pcp

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:pcpParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-Organization-put-pcp-update

Element id

Parameters.parameter:pcpParameter.resource

Short description

n/a

Definition

The organization resource

Requirements

n/a

Comments

n/a

Data type

profile-Organization-put-pcp-update

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0

Mappings

rim: Entity. Role, or Act
v2: (also see master files messages)
rim: Organization(classCode=ORG, determinerCode=INST)
servd: Organization
w5: administrative.group

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

Element id

Parameters.parameter:pcpParameter.resource.extension

Short description

n/a

Alternate names

extensions, user content

Definition

Extension element of enrollment capacity

Requirements

n/a

Comments

n/a

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
extension-url-allowed-values: Url allowed values: ('http://ihis.sg/extension/enrollment-capacity')
($this.url in ('http://ihis.sg/extension/enrollment-capacity'))

Mappings

rim: n/a
rim: N/A

EnrollmentCapacity

0..1

Extension(integer)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.extension:EnrollmentCapacity

Short description

n/a

Alternate names

extensions, user content

Definition

Extension element of enrollment capacity

Requirements

n/a

Comments

n/a

Data type

Extension(integer)

Extension URL

http://ihis.sg/extension/enrollment-capacity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

Σ C

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Fixed Value

http://ihis.sg/identifier/hci-code

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.value

Short description

n/a

Definition

The PCP's HCI code

Requirements

n/a

Comments

Sample Value : "HCI-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

HCI-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.active

Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
v2: No equivalent in HL7 v2
rim: .status
servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

type

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.type

Short description

Kind of organization

Definition

The kind(s) of organization that this is.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

CodeableConcept

Binding

Used to categorize the organization.

OrganizationType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

name

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.name

Short description

n/a

Definition

The name of the PCP

Requirements

n/a

Comments

Mandatory when the reason is "add". Sample Value : "HSG Clinic"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

HSG Clinic

Mappings

rim: n/a
v2: XON.1
rim: .name
servd: .PreferredName/Name

alias

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.alias

Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .name

telecom

0..1

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

If this section does not present when Reason is add, system will auto populate this section with empty string "" as email address.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-3

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

Σ C

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.system

Short description

n/a

Definition

Organization Contact

Requirements

n/a

Comments

Fixed Value: "email"

Data type

code

Binding

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

email

Examples
Fixed Value

email

Mappings

rim: n/a
v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

Σ C

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.value

Short description

n/a

Definition

The email address

Requirements

n/a

Comments

Sample Value: "helpdesk@parkway.com"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
organization-email-validation: Email address does not follow the format.
$this.trim().length() = 0 or $this.toString().matches('^[a-zA-Z0-9][a-zA-Z0-9._%+-]*@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$')
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Examples
Sample Value

helpdesk@parkway.com

Mappings

rim: n/a
v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..0

positiveInt

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies 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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: n/a

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..0

Address

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.address

Short description

An address for the organization

Definition

An address for the organization.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XAD
rim: AD
servd: Address
v2: ORC-23?
rim: .address
servd: ./PrimaryAddress and ./OtherAddresses

partOf

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.partOf

Short description

The organization of which this organization forms a part

Definition

The organization of which this organization forms a part.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: No equivalent in HL7 v2
rim: .playedBy[classCode=Part].scoper
servd: n/a

contact

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.contact

Short description

Contact for the organization for a certain purpose

Definition

Contact for the organization for a certain purpose.

Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .contactParty

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcpParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:pcpParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

clusterRelationshipParameter

Σ C

0..1

BackboneElement

Element id

Parameters.parameter:clusterRelationshipParameter

Short description

n/a

Definition

"cluster-relationship" parameter

Requirements

n/a

Comments

Mandatory when the reason is "add"

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
cluster-relationship-parameter-exists: Cluster Relaionship Exists
(where(name='cluster-relationship').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:clusterRelationshipParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "cluster-relationship"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

cluster-relationship

Examples
Fixed Value

cluster-relationship

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:clusterRelationshipParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-OrganizationAffiliation-put-pcp

Element id

Parameters.parameter:clusterRelationshipParameter.resource

Short description

n/a

Definition

The organization Affilication resource

Requirements

n/a

Comments

n/a

Data type

profile-OrganizationAffiliation-put-pcp

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period

Short description

n/a

Definition

The period during the clinic is affiliated with the cluster

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization

Short description

n/a

Definition

Reference of the related cluster

Requirements

n/a

Comments

Reference related cluster

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.value

Short description

n/a

Definition

The cluster code

Requirements

n/a

Comments

Sample Value : "Cluster-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

cluster-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:clusterRelationshipParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:clusterRelationshipParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

pcnRelationshipParameter

Σ C

0..1

BackboneElement

Element id

Parameters.parameter:pcnRelationshipParameter

Short description

n/a

Definition

"pcn-relationship" parameter

Requirements

n/a

Comments

Mandatory when the reason is "add"

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
pcn-relationship-parameter-exists: PCN relationship exists
(where(name='pcn-relationship').exists())

Mappings

rim: n/a

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

name

1..1

stringFixed Value

Element id

Parameters.parameter:pcnRelationshipParameter.name

Short description

n/a

Definition

Name of parameter

Requirements

n/a

Comments

Fixed Value: "pcn-relationship"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

pcn-relationship

Examples
Fixed Value

pcn-relationship

Mappings

rim: n/a

value[x]

Σ C

0..0

Element id

Parameters.parameter:pcnRelationshipParameter.value[x]

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

resource

Σ C

1..1

profile-OrganizationAffiliation-put-pcp-pcn

Element id

Parameters.parameter:pcnRelationshipParameter.resource

Short description

n/a

Definition

The organization Affilication resource

Requirements

n/a

Comments

n/a

Data type

profile-OrganizationAffiliation-put-pcp-pcn

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period

Short description

n/a

Definition

The period during the clinic is affiliated with the PCN

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization

Short description

n/a

Definition

Reference of the related PCN

Requirements

n/a

Comments

Reference related PCN

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.value

Short description

n/a

Definition

The PCN code

Requirements

n/a

Comments

Sample Value : "PCN-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

PCN-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Parameters.parameter:pcnRelationshipParameter.resource.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

part

0..0

see (parameter)

Element id

Parameters.parameter:pcnRelationshipParameter.part

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

profile-Organization-put-pcp-add (Organization)

profile-Organization-put-pcp-base

There are no (further) constraints on this element

Element id

Organization

Short description

A grouping of people or organizations with a common purpose

Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Data type

profile-Organization-put-pcp-base

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0

Mappings

rim: Entity. Role, or Act
v2: (also see master files messages)
rim: Organization(classCode=ORG, determinerCode=INST)
servd: Organization
w5: administrative.group

0..0

There are no (further) constraints on this element

Element id

Organization.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

Organization.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Organization.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Organization.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

Organization.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

Organization.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

EnrollmentCapacity

1..1

Extension(integer)

Element id

Organization.extension:EnrollmentCapacity

Short description

n/a

Alternate names

extensions, user content

Definition

Extension element of enrollment capacity

Requirements

n/a

Comments

n/a

Data type

Extension(integer)

Extension URL

http://ihis.sg/extension/enrollment-capacity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

Organization.extension:EnrollmentCapacity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Organization.extension:EnrollmentCapacity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Organization.extension:EnrollmentCapacity.url

Short description

n/a

Definition

Extension of enrollment capacity

Requirements

n/a

Comments

Fixed Value: "http://ihis.sg/extension/enrollment-capacity"

Data type

uri

Fixed value

http://ihis.sg/extension/enrollment-capacity

Mappings

rim: N/A

value[x]

1..1

Element id

Organization.extension:EnrollmentCapacity.value[x]

Short description

n/a

Definition

Enrollment Capacity (Default Value: 9999)

Requirements

n/a

Comments

Sample Value : 500

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Minimum value

Examples
Sample Value

Mappings

rim: n/a
rim: N/A

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

Organization.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

Σ C

1..1

Identifier

There are no (further) constraints on this element

Element id

Organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Fixed Value

http://ihis.sg/identifier/hci-code

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Organization.identifier.value

Short description

n/a

Definition

The PCP's HCI code

Requirements

n/a

Comments

Sample Value : "HCI-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

HCI-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..0

boolean

There are no (further) constraints on this element

Element id

Organization.active

Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
v2: No equivalent in HL7 v2
rim: .status
servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

type

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

Organization.type

Short description

Kind of organization

Definition

The kind(s) of organization that this is.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

CodeableConcept

Binding

Used to categorize the organization.

OrganizationType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

name

Σ C

1..1

string

There are no (further) constraints on this element

Element id

Organization.name

Short description

n/a

Definition

The name of the PCP

Requirements

n/a

Comments

Mandatory when the reason is "add". Sample Value : "HSG Clinic"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

HSG Clinic

Mappings

rim: n/a
v2: XON.1
rim: .name
servd: .PreferredName/Name

alias

0..0

string

There are no (further) constraints on this element

Element id

Organization.alias

Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .name

telecom

0..1

ContactPoint

There are no (further) constraints on this element

Element id

Organization.telecom

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

If this section does not present when Reason is add, system will auto populate this section with empty string "" as email address.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-3

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

0..0

There are no (further) constraints on this element

Element id

Organization.telecom.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Organization.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

Σ C

1..1

codeBindingFixed Value

There are no (further) constraints on this element

Element id

Organization.telecom.system

Short description

n/a

Definition

Organization Contact

Requirements

n/a

Comments

Fixed Value: "email"

Data type

code

Binding

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

email

Examples
Fixed Value

email

Mappings

rim: n/a
v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

Σ C

1..1

string

There are no (further) constraints on this element

Element id

Organization.telecom.value

Short description

n/a

Definition

The email address

Requirements

n/a

Comments

Sample Value: "helpdesk@parkway.com"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
organization-email-validation: Email address does not follow the format.
$this.trim().length() = 0 or $this.toString().matches('^[a-zA-Z0-9][a-zA-Z0-9._%+-]*@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$')
max-string-length-255: String length must not exceed 255 characters
$this.toString().length() <= 255

Examples
Sample Value

helpdesk@parkway.com

Mappings

rim: n/a
v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Organization.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..0

positiveInt

There are no (further) constraints on this element

Element id

Organization.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies 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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: n/a

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

Organization.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..0

Address

There are no (further) constraints on this element

Element id

Organization.address

Short description

An address for the organization

Definition

An address for the organization.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, org-2

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

rim: n/a
v2: XAD
rim: AD
servd: Address
v2: ORC-23?
rim: .address
servd: ./PrimaryAddress and ./OtherAddresses

partOf

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

Organization.partOf

Short description

The organization of which this organization forms a part

Definition

The organization of which this organization forms a part.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: No equivalent in HL7 v2
rim: .playedBy[classCode=Part].scoper
servd: n/a

contact

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Organization.contact

Short description

Contact for the organization for a certain purpose

Definition

Contact for the organization for a certain purpose.

Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: .contactParty

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Organization.endpoint

Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

profile-OrganizationAffiliation-put-pcp (OrganizationAffiliation)

OrganizationAffiliation

There are no (further) constraints on this element

Element id

OrganizationAffiliation

Short description

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship

Definition

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Data type

OrganizationAffiliation

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

OrganizationAffiliation.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

OrganizationAffiliation.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

OrganizationAffiliation.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

OrganizationAffiliation.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

OrganizationAffiliation.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

OrganizationAffiliation.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

Element id

OrganizationAffiliation.period

Short description

n/a

Definition

The period during the clinic is affiliated with the cluster

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

Element id

OrganizationAffiliation.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

Element id

OrganizationAffiliation.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

Element id

OrganizationAffiliation.organization

Short description

n/a

Definition

Reference of the related cluster

Requirements

n/a

Comments

Reference related cluster

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

Element id

OrganizationAffiliation.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

Element id

OrganizationAffiliation.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

Element id

OrganizationAffiliation.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

Element id

OrganizationAffiliation.organization.identifier.value

Short description

n/a

Definition

The cluster code

Requirements

n/a

Comments

Sample Value : "Cluster-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

cluster-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

OrganizationAffiliation.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

OrganizationAffiliation.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

profile-OrganizationAffiliation-put-pcp-pcn (OrganizationAffiliation)

OrganizationAffiliation

There are no (further) constraints on this element

Element id

OrganizationAffiliation

Short description

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship

Definition

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Data type

OrganizationAffiliation

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role
w5: administrative.individual

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..1

Meta

There are no (further) constraints on this element

Element id

OrganizationAffiliation.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

OrganizationAffiliation.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

OrganizationAffiliation.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

OrganizationAffiliation.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

OrganizationAffiliation.identifier

Short description

Business identifiers that are specific to this role

Definition

Business identifiers that are specific to this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
rim: .id

active

0..0

boolean

There are no (further) constraints on this element

Element id

OrganizationAffiliation.active

Short description

Whether this organization affiliation record is in active use

Definition

Whether this organization affiliation record is in active use.

Requirements

Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
w5: FiveWs.status
rim: .statusCode

period

Σ C

1..1

Period

Element id

OrganizationAffiliation.period

Short description

n/a

Definition

The period during the clinic is affiliated with the PCN

Requirements

n/a

Comments

n/a

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

Σ C

1..1

dateTime

Element id

OrganizationAffiliation.period.start

Short description

n/a

Definition

Affliation start date

Requirements

n/a

Comments

Sample value: "2022-08-22"

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-01-01

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

Σ C

0..1

dateTime

Element id

OrganizationAffiliation.period.end

Short description

n/a

Definition

Affliation end date

Requirements

n/a

Comments

Sample value: "2023-08-22"

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
Sample Value

2023-12-30

Mappings

rim: n/a
v2: DR.2
rim: ./high

organization

Σ C

1..1

Reference(Organization)

Element id

OrganizationAffiliation.organization

Short description

n/a

Definition

Reference of the related PCN

Requirements

n/a

Comments

Reference related PCN

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..0

string

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

type

1..1

uriBindingFixed Value

Element id

OrganizationAffiliation.organization.type

Short description

n/a

Definition

Indicate that the the identifier below is for Organization

Requirements

n/a

Comments

Fixed Value: "Organization"

Data type

uri

Binding

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

Organization

Examples
Fixed Value

Organization

Mappings

rim: n/a
rim: N/A

identifier

1..1

Identifier

Element id

OrganizationAffiliation.organization.identifier

Short description

n/a

Definition

n/a

Requirements

n/a

Comments

n/a

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..0

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uriFixed Value

Element id

OrganizationAffiliation.organization.identifier.system

Short description

n/a

Definition

The namespace for the identifier value, HCI Code

Requirements

n/a

Comments

Fixed Value : "http://ihis.sg/identifier/hci-code"

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Fixed value

http://ihis.sg/identifier/hci-code

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

Element id

OrganizationAffiliation.organization.identifier.value

Short description

n/a

Definition

The PCN code

Requirements

n/a

Comments

Sample Value : "PCN-001"

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Examples
General

Sample Value

PCN-001

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..0

Period

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..0

string

There are no (further) constraints on this element

Element id

OrganizationAffiliation.organization.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

participatingOrganization

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.participatingOrganization

Short description

Organization that provides/performs the role (e.g. providing services or is a member of)

Definition

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player

network

Σ C

0..0

Reference(Organization)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.network

Short description

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

Definition

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

code

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

OrganizationAffiliation.code

Short description

Definition of the role the participatingOrganization plays

Definition

Definition of the role the participatingOrganization plays in the association.

Comments

Data type

CodeableConcept

Binding

The role the participating organization providing services to the primary organization.

OrganizationAffiliationRole (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

OrganizationAffiliation.specialty

Short description

Specific specialty of the participatingOrganization in the context of the role

Definition

Specific specialty of the participatingOrganization in the context of the role.

Comments

Data type

CodeableConcept

Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .player.HealthCareProvider[@classCode = 'PROV'].code

location

Σ C

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.location

Short description

The location(s) at which the role occurs

Definition

The location(s) at which the role occurs.

Comments

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.healthcareService

Short description

Healthcare services provided through the role

Definition

Healthcare services provided through the role.

Comments

Data type

Reference(HealthcareService)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

Σ C

0..0

ContactPoint

There are no (further) constraints on this element

Element id

OrganizationAffiliation.telecom

Short description

Contact details at the participatingOrganization relevant to this Affiliation

Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom

endpoint

0..0

Reference(Endpoint)

There are no (further) constraints on this element

Element id

OrganizationAffiliation.endpoint

Short description

Technical endpoints providing access to services operated for this role

Definition

Technical endpoints providing access to services operated for this role.

Comments

Data type

Reference(Endpoint)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

profile-output-operation-outcome (OperationOutcome)

OperationOutcome

Element id

OperationOutcome

Short description

n/a

Definition

Outcome of Operation

Comments

Can result from the failure of a REST call or be part of the response message returned from a request message.

Data type

OperationOutcome

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
w5: infrastructure.exchange

0..0

There are no (further) constraints on this element

Element id

OperationOutcome.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

meta

0..0

Meta

There are no (further) constraints on this element

Element id

OperationOutcome.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

OperationOutcome.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

IETF language tag

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

OperationOutcome.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..0

Resource

There are no (further) constraints on this element

Element id

OperationOutcome.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Constraints

dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..0

Extension

There are no (further) constraints on this element

Element id

OperationOutcome.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..0

Extension

There are no (further) constraints on this element

Element id

OperationOutcome.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

issue

1..1

BackboneElement

Element id

OperationOutcome.issue

Short description

n/a

Definition

An error, warning, or information message that results from a system action.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR
rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

0..1

There are no (further) constraints on this element

Element id

OperationOutcome.issue.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

OperationOutcome.issue.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..0

Extension

There are no (further) constraints on this element

Element id

OperationOutcome.issue.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

severity

1..1

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.issue.severity

Short description

fatal | error | warning | information

Definition

Indicates whether the issue indicates a variation from successful processing.

Requirements

Indicates how relevant the issue is to the overall success of the action.

Comments

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

Data type

code

Binding

How the issue affects the success of the action.

IssueSeverity (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-4
rim: ./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]

code

1..1

codeBinding

There are no (further) constraints on this element

Element id

OperationOutcome.issue.code

Short description

Error or warning code

Definition

Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

Requirements

Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

A code that describes the type of issue.

IssueType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-3
rim: ./code

details

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

OperationOutcome.issue.details

Short description

Additional details about the error

Definition

Additional details about the error. This may be a text description of the error or a system code that identifies the error.

Comments

A human readable description of the error issue SHOULD be placed in details.text.

Data type

CodeableConcept

Binding

A code that provides details as the exact issue.

http://hl7.org/fhir/ValueSet/operation-outcome (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: ERR-5
rim: ./code

diagnostics

0..0

string

There are no (further) constraints on this element

Element id

OperationOutcome.issue.diagnostics

Short description

Additional diagnostic information about the issue

Definition

Additional diagnostic information about the issue.

Comments

This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-8
rim: ./text[parent::AcknowledgmentDetail]

location

0..0

string

There are no (further) constraints on this element

Element id

OperationOutcome.issue.location

Short description

Deprecated: Path of element(s) related to issue

Definition

This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.

For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.

Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-2
rim: ./location[parent::AcknowledgmentDetail]

expression

0..0

string

There are no (further) constraints on this element

Element id

OperationOutcome.issue.expression

Short description

FHIRPath of element(s) related to issue

Definition

A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

Requirements

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

Comments

The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters

Mappings

rim: n/a
v2: ERR-2
rim: ./location[parent::AcknowledgmentDetail]

Error Response

Click here for General API Error Handling

Custom Error Codes

Refer to

Command 'pagelink' could not render: Page not found.

for the list of custom error codes specific to this API.