Specialty Patient Enrollment for Pharmacies

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

The purpose of this identifier.

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

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

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

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

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

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

Organization that issued/manages the identifier.

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

Note that FHIR strings SHALL NOT exceed 1MB in size

The reference details for the link.

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

A series of links that provide context to this entry.

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

• fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
• Results from operations might involve resources that are not identified.

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

A series of links that provide context to this entry.

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

When searching, the server's search ranking score for the entry.

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Note that FHIR strings SHALL NOT exceed 1MB in size

The URL for this entry, relative to the root (the address to which the request is posted).

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Note that FHIR strings SHALL NOT exceed 1MB in size

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Note that FHIR strings SHALL NOT exceed 1MB in size

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Note that FHIR strings SHALL NOT exceed 1MB in size

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Note that FHIR strings SHALL NOT exceed 1MB in size

The location header created by processing this operation, populated if the operation returns a location.

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

The date/time that the resource was modified on the server.

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

A series of links that provide context to this entry.

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

When searching, the server's search ranking score for the entry.

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Note that FHIR strings SHALL NOT exceed 1MB in size

The URL for this entry, relative to the root (the address to which the request is posted).

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Note that FHIR strings SHALL NOT exceed 1MB in size

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Note that FHIR strings SHALL NOT exceed 1MB in size

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Note that FHIR strings SHALL NOT exceed 1MB in size

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Note that FHIR strings SHALL NOT exceed 1MB in size

The location header created by processing this operation, populated if the operation returns a location.

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

The date/time that the resource was modified on the server.

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

A series of links that provide context to this entry.

An identifier for this patient.

Patients are almost always assigned specific numerical identifiers.

For provider-initiated transactions, the Medical Record Number (MRN) will always be present. This identifier will be identified with the Patient.identifyer.type, as follows:

1. system: “http://terminology.hl7.org/CodeSystem/v2-0203”
2. code: “MR”

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Need to be able to mark a patient record as not to be used because it was created in error.

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Identifies the purpose for this name.

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

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

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

A renderable, unencoded form.

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Given name.

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Note that FHIR strings SHALL NOT exceed 1MB in size

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Note that FHIR strings SHALL NOT exceed 1MB in size

Indicates the period of time when this name was valid for the named person.

Allows names to be placed in historical context.

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

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

Telecommunications form for contact point - what communications system is required to make use of the contact.

Note that FHIR strings SHALL NOT exceed 1MB in size

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Need to support legacy numbers that are not in a tightly controlled format.

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Identifies the purpose for the contact point.

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

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

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.

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

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

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

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

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Needed for identification of the individual, in combination with (at least) name and birth date.

The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

The date of birth for the individual.

Age of the individual drives many clinical processes.

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

The purpose of this address.

Allows an appropriate address to be chosen from a list of many.

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

A renderable, unencoded form.

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Note that FHIR strings SHALL NOT exceed 1MB in size

The name of the city, town, suburb, village or other community or delivery center.

Note that FHIR strings SHALL NOT exceed 1MB in size

The name of the administrative area (county).

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Note that FHIR strings SHALL NOT exceed 1MB in size

A postal code designating a region defined by the postal service.

Note that FHIR strings SHALL NOT exceed 1MB in size

Country - a nation as commonly understood or generally accepted.

ISO 3166 3 letter codes can be used in place of a human readable country name.

Time period when address was/is in use.

Allows addresses to be placed in historical context.

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

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

This field contains a patient's most recent marital (civil) status.

Most, if not all systems capture it.

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.

Image of the patient.

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Guidelines:

• Use id photos, not clinical photos.
• Limit dimensions to thumbnail.
• Keep byte count low to ease resource updates.

The nature of the relationship between the patient and the contact person.

Used to determine which contact person is the most relevant to approach, depending on circumstances.

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.

A name associated with the contact person.

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

A contact detail for the person, e.g. a telephone number or an email address.

People have (primary) ways to contact them in some way such as phone, email.

Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Address for the contact person.

Need to keep track where the contact person can be contacted per postal mail or visited.

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

Needed to address the person correctly.

Note that FHIR strings SHALL NOT exceed 1MB in size

Organization on behalf of which the contact is acting or for which the contact is working.

For guardians or business related contacts, the organization is relevant.

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

The period during which this contact person or organization is valid to be contacted relating to this patient.

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

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

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

This language is specifically identified for communicating healthcare information.

Patient's nominated care provider.

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Organization that is the custodian of the patient record.

Need to know who recognizes this patient record, manages and updates it.

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

The other patient resource that the link refers to.

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

The type of link between this patient resource and another patient resource.

Note that FHIR strings SHALL NOT exceed 1MB in size

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

When searching, the server's search ranking score for the entry.

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Note that FHIR strings SHALL NOT exceed 1MB in size

The URL for this entry, relative to the root (the address to which the request is posted).

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Note that FHIR strings SHALL NOT exceed 1MB in size

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Note that FHIR strings SHALL NOT exceed 1MB in size