Codes, extension, profiles and more
1.0.0 - ci-build
Codes, extension, profiles and more
1.0.0 - ci-build
Codes, extension, profiles and more - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: http://helsenorge.no/fhir/StructureDefinition/MyPatient | Version: 1.0.0 | |||
| Active as of 2024-06-12 | Computable Name: MyPatient | |||
An example profile of the Patient resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
  implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| active | ?!ΣN | 0..1 | boolean | Whether this patient's record is in active use |
 name | SΣ | 1..* | HumanName | A name associated with the patient |
  deceased[x] | ?!ΣN | 0..1 | Indicates if the individual is deceased or not | |
 deceasedBoolean | boolean | |||
 deceasedDateTime | dateTime | |||
 link | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
 modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | ΣN | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | error | Patient | 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 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | ΣN | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
| language | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | ΣN | 0..* | Identifier | An identifier for this patient | ||||
| active | ?!ΣN | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | SΣ | 1..* | HumanName | A name associated with the patient | ||||
| telecom | ΣCN | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | ΣN | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | ΣN | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!ΣN | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | ΣN | 0..* | Address | An address for the individual | ||||
| maritalStatus | N | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
| multipleBirth[x] | N | 0..1 | Whether patient is part of a multiple birth | |||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | CN | 0..* | Attachment | Image of the patient | ||||
| contact | CN | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | N | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
| name | N | 0..1 | HumanName | A name associated with the contact person | ||||
| telecom | CN | 0..* | ContactPoint | A contact detail for the person | ||||
| address | N | 0..1 | Address | Address for the contact person | ||||
| gender | N | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| organization | CN | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | CN | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| communication | N | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | N | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||
| preferred | N | 0..1 | boolean | Language preference indicator | ||||
| generalPractitioner | CN | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
| managingOrganization | ΣCN | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | ΣN | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | error | Patient | 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 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| per-1 | error | Patient.contact.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Patient
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
 name | S | 1..* | HumanName | A name associated with the patient |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| active | ?!ΣN | 0..1 | boolean | Whether this patient's record is in active use |
| name | SΣ | 1..* | HumanName | A name associated with the patient |
| deceased[x] | ?!ΣN | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| link | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | ΣN | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | error | Patient | 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 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | ΣN | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
| language | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | ΣN | 0..* | Identifier | An identifier for this patient | ||||
| active | ?!ΣN | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | SΣ | 1..* | HumanName | A name associated with the patient | ||||
| telecom | ΣCN | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | ΣN | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | ΣN | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!ΣN | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | ΣN | 0..* | Address | An address for the individual | ||||
| maritalStatus | N | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
| multipleBirth[x] | N | 0..1 | Whether patient is part of a multiple birth | |||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | CN | 0..* | Attachment | Image of the patient | ||||
| contact | CN | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | N | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
| name | N | 0..1 | HumanName | A name associated with the contact person | ||||
| telecom | CN | 0..* | ContactPoint | A contact detail for the person | ||||
| address | N | 0..1 | Address | Address for the contact person | ||||
| gender | N | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| organization | CN | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | CN | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| communication | N | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | N | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||
| preferred | N | 0..1 | boolean | Language preference indicator | ||||
| generalPractitioner | CN | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
| managingOrganization | ΣCN | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | ΣN | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | error | Patient | 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 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| per-1 | error | Patient.contact.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Patient
Other representations of profile: CSV, Excel, Schematron