Implementation Guide
23.0.0 - R4 APIs
Publish Box goes here
| Active as of 2022-03-01 |
Definitions for the athena-posting-profile resource profile.
Guidance on how to interpret the contents of this table can be found here
| 0. Basic | |
| Definition | Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification. |
| Short | Resource for non-supported content |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Z-resource, Extension-resource, Custom-resource |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. Basic.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| 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. |
| Control | 10..1 |
| Type | idstring |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| 4. Basic.meta | |
| 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. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Basic.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| Control | 10..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Basic.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | 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. |
| Control | 10..* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Basic.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Basic.meta.profile:Athena Posting Profile | |
| Slice Name | Athena Posting Profile |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | The Athena Posting Profile defines the capabilities of the Posting Resource supported by Athena products. 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. |
| Control | 10..1* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-profile |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Basic.implicitRules | |
| 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. |
| Short | A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Basic.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional content defined by implementations |
| 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. |
| Control | 30..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Basic.extension:batch | |
| Slice Name | batch |
| Definition | An Extension |
| Short | Extension |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Batch) (Extension Type: integer) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 18. Basic.extension:batch.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-batch |
| 20. Basic.extension:batch.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 |
| Type | integer, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Basic.extension:Date | |
| Slice Name | Date |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 24. Basic.extension:Amount | |
| Slice Name | Amount |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 26. Basic.extension:AmountApplied | |
| Slice Name | AmountApplied |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 28. Basic.extension:InsuranceAmount | |
| Slice Name | InsuranceAmount |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 30. Basic.extension:payerName | |
| Slice Name | payerName |
| Definition | An Extension |
| Short | Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(PayerName) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 32. Basic.extension:payerName.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-payerName |
| 34. Basic.extension:payerName.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Basic.extension:PayerId | |
| Slice Name | PayerId |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 38. Basic.extension:PayerType | |
| Slice Name | PayerType |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 40. Basic.extension:PaymentType | |
| Slice Name | PaymentType |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 42. Basic.extension:CheckCardNumber | |
| Slice Name | CheckCardNumber |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 44. Basic.extension:CheckDate | |
| Slice Name | CheckDate |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 46. Basic.extension:CardTypeMID | |
| Slice Name | CardTypeMID |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 48. Basic.extension:AccountNumber | |
| Slice Name | AccountNumber |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 50. Basic.extension:MoneyOrderType | |
| Slice Name | MoneyOrderType |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 52. Basic.extension:InsuranceReference | |
| Slice Name | InsuranceReference |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 54. Basic.extension:DateOfDeposit | |
| Slice Name | DateOfDeposit |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 56. Basic.extension:patientVisitId | |
| Slice Name | patientVisitId |
| Definition | An Extension |
| Short | Patient Visit Id |
| Comments | Visit id of patient. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(PatientVisitId) (Extension Type: integer) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 58. Basic.extension:patientVisitId.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-patientVisitId |
| 60. Basic.extension:patientVisitId.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 |
| Type | integer, date, Meta, Address, Attachment, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Basic.modifierExtension | |
| 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). |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Summary | false |
| 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. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 64. Basic.identifier | |
| Definition | Identifier assigned to the resource for business purposes, outside the context of FHIR. |
| Short | External ids for this itemBusiness identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Basic.code | |
| Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. |
| Short | Kind of Resource |
| Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored. |
| Control | 1..1 |
| Binding | For example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type (example to http://hl7.org/fhir/ValueSet/basic-resource-type)Codes for identifying types of resources not yet defined by FHIR. |
| Type | CodeableConcept |
| Is Modifier | true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements. |
| Must Support | true |
| Summary | true |
| Requirements | Must be able to distinguish different types of Basic resources. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. Basic.subject | |
| Definition | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. |
| Short | Identifies the focus of this resource |
| Comments | Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Needed for partitioning the resource by Patient. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. Basic.created | |
| Definition | Identifies when the resource was first created. |
| Short | When created |
| Control | 0..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows ordering resource instances by time. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Basic.author | |
| Definition | Indicates who was responsible for creating the resource instance. |
| Short | Who created |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Needed for partitioning the resource. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Basic | |
| Short | Resource for non-supported content |
| Must Support | false |
| Alternate Names | Z-resource, Extension-resource, Custom-resource |
| 2. Basic.id | |
| Control | 1..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 4. Basic.meta | |
| Control | 0..1 |
| Type | Meta |
| Must Support | true |
| 6. Basic.meta.lastUpdated | |
| Control | 1..1 |
| Type | instant |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 8. Basic.meta.profile | |
| Control | 1..* |
| Type | canonical |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Slicing | This element introduces a set of slices on Basic.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Basic.meta.profile:Athena Posting Profile | |
| Slice Name | Athena Posting Profile |
| Comments | The Athena Posting Profile defines the capabilities of the Posting Resource supported by Athena products. |
| Control | 1..1 |
| Type | canonical |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-profile |
| 12. Basic.extension:batch | |
| Slice Name | batch |
| Control | 1..1 |
| Type | Extension(Batch) (Extension Type: integer) |
| Must Support | false |
| 14. Basic.extension:batch.url | |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-batch |
| 16. Basic.extension:batch.value[x] | |
| Control | 1..1 |
| Type | integer |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 18. Basic.extension:Date | |
| Slice Name | Date |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 20. Basic.extension:Amount | |
| Slice Name | Amount |
| Control | 1..1 |
| Type | Extension |
| Must Support | false |
| 22. Basic.extension:AmountApplied | |
| Slice Name | AmountApplied |
| Control | 1..1 |
| Type | Extension |
| Must Support | false |
| 24. Basic.extension:InsuranceAmount | |
| Slice Name | InsuranceAmount |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 26. Basic.extension:payerName | |
| Slice Name | payerName |
| Control | 0..1 |
| Type | Extension(PayerName) (Extension Type: string) |
| Must Support | false |
| 28. Basic.extension:payerName.url | |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-payerName |
| 30. Basic.extension:payerName.value[x] | |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 32. Basic.extension:PayerId | |
| Slice Name | PayerId |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 34. Basic.extension:PayerType | |
| Slice Name | PayerType |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 36. Basic.extension:PaymentType | |
| Slice Name | PaymentType |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 38. Basic.extension:CheckCardNumber | |
| Slice Name | CheckCardNumber |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 40. Basic.extension:CheckDate | |
| Slice Name | CheckDate |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 42. Basic.extension:CardTypeMID | |
| Slice Name | CardTypeMID |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 44. Basic.extension:AccountNumber | |
| Slice Name | AccountNumber |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 46. Basic.extension:MoneyOrderType | |
| Slice Name | MoneyOrderType |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 48. Basic.extension:InsuranceReference | |
| Slice Name | InsuranceReference |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 50. Basic.extension:DateOfDeposit | |
| Slice Name | DateOfDeposit |
| Control | 0..1 |
| Type | Extension |
| Must Support | false |
| 52. Basic.extension:patientVisitId | |
| Slice Name | patientVisitId |
| Short | Patient Visit Id |
| Comments | Visit id of patient. |
| Control | 0..1 |
| Type | Extension(PatientVisitId) (Extension Type: integer) |
| Must Support | false |
| 54. Basic.extension:patientVisitId.url | |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-patientVisitId |
| 56. Basic.extension:patientVisitId.value[x] | |
| Control | 1..1 |
| Type | integer |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 58. Basic.identifier | |
| Short | External ids for this item |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Must Support | false |
| 60. Basic.code | |
| Short | Kind of Resource |
| Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. |
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| 62. Basic.subject | |
| Short | Identifies the focus of this resource |
| Comments | Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. |
| Control | 0..1 |
| Type | Reference(Resource) |
| Must Support | false |
| 64. Basic.created | |
| Short | When created |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 66. Basic.author | |
| Short | Who created |
| Control | 0..1 |
| Type | Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization) |
| Must Support | false |
Guidance on how to interpret the contents of this table can be found here
| 0. Basic | |||||
| Definition | Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification. | ||||
| Short | Resource for non-supported content | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | Z-resource, Extension-resource, Custom-resource | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||
| 2. Basic.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 1..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 4. Basic.meta | |||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Basic.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 8. Basic.meta.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Basic.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Basic.meta.versionId | |||||
| Definition | 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. | ||||
| Short | Version specific identifier | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Basic.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 1..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. Basic.meta.source | |||||
| Definition | 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. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. Basic.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | 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. | ||||
| Control | 1..* | ||||
| Type | canonical | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Basic.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 18. Basic.meta.profile:Athena Posting Profile | |||||
| Slice Name | Athena Posting Profile | ||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | The Athena Posting Profile defines the capabilities of the Posting Resource supported by Athena products. | ||||
| Control | 1..1 | ||||
| Type | canonical | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-profile | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Basic.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Basic.meta.tag | |||||
| Definition | 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. | ||||
| Short | Tags applied to this resource | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Basic.implicitRules | |||||
| 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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Basic.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Basic.text | |||||
| 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Basic.contained | |||||
| 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. | ||||
| Short | Contained, inline Resources | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 32. Basic.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 3..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 34. Basic.extension:batch | |||||
| Slice Name | batch | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Batch) (Extension Type: integer) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 36. Basic.extension:batch.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 38. Basic.extension:batch.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Basic.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. Basic.extension:batch.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-batch | ||||
| 42. Basic.extension:batch.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 | ||||
| Type | integer | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Basic.extension:Date | |||||
| Slice Name | Date | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 46. Basic.extension:Amount | |||||
| Slice Name | Amount | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 48. Basic.extension:AmountApplied | |||||
| Slice Name | AmountApplied | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 50. Basic.extension:InsuranceAmount | |||||
| Slice Name | InsuranceAmount | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 52. Basic.extension:payerName | |||||
| Slice Name | payerName | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(PayerName) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 54. Basic.extension:payerName.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 56. Basic.extension:payerName.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Basic.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 58. Basic.extension:payerName.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-payerName | ||||
| 60. Basic.extension:payerName.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. Basic.extension:PayerId | |||||
| Slice Name | PayerId | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 64. Basic.extension:PayerType | |||||
| Slice Name | PayerType | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 66. Basic.extension:PaymentType | |||||
| Slice Name | PaymentType | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 68. Basic.extension:CheckCardNumber | |||||
| Slice Name | CheckCardNumber | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 70. Basic.extension:CheckDate | |||||
| Slice Name | CheckDate | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 72. Basic.extension:CardTypeMID | |||||
| Slice Name | CardTypeMID | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. Basic.extension:AccountNumber | |||||
| Slice Name | AccountNumber | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 76. Basic.extension:MoneyOrderType | |||||
| Slice Name | MoneyOrderType | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 78. Basic.extension:InsuranceReference | |||||
| Slice Name | InsuranceReference | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 80. Basic.extension:DateOfDeposit | |||||
| Slice Name | DateOfDeposit | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 82. Basic.extension:patientVisitId | |||||
| Slice Name | patientVisitId | ||||
| Definition | An Extension | ||||
| Short | Patient Visit Id | ||||
| Comments | Visit id of patient. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(PatientVisitId) (Extension Type: integer) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 84. Basic.extension:patientVisitId.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 86. Basic.extension:patientVisitId.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Basic.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 88. Basic.extension:patientVisitId.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-posting-extension-patientVisitId | ||||
| 90. Basic.extension:patientVisitId.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 | ||||
| Type | integer | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. Basic.modifierExtension | |||||
| 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). | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 94. Basic.identifier | |||||
| Definition | Identifier assigned to the resource for business purposes, outside the context of FHIR. | ||||
| Short | External ids for this item | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Basic.code | |||||
| Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. | ||||
| Short | Kind of Resource | ||||
| Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see BasicResourceTypes (example to http://hl7.org/fhir/ValueSet/basic-resource-type)Codes for identifying types of resources not yet defined by FHIR. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements. | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Must be able to distinguish different types of Basic resources. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Basic.subject | |||||
| Definition | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | ||||
| Short | Identifies the focus of this resource | ||||
| Comments | Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Needed for partitioning the resource by Patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Basic.created | |||||
| Definition | Identifies when the resource was first created. | ||||
| Short | When created | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Allows ordering resource instances by time. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Basic.author | |||||
| Definition | Indicates who was responsible for creating the resource instance. | ||||
| Short | Who created | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Needed for partitioning the resource. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||